Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 967 Bytes

File metadata and controls

21 lines (15 loc) · 967 Bytes

Citadel docs

These pages cover the current public API for citadel_cli.

One important concept up front: Citadel is prefix-driven. Users usually do not type full command names. They type the shortest unambiguous prefix and Citadel expands it into the full command path.

Read them in order:

  1. Installing Citadel in an existing React app
  2. Defining commands
  3. Embedding Citadel and choosing a display mode
  4. Configuring Citadel and command history
  5. Using integration recipes

Notes:

  • Citadel is a React component library, so the examples assume an existing React app.
  • Citadel mounts into a shadow DOM, so its UI styles stay isolated from the host app.
  • The code samples in these docs are backed by type-checked examples in docs/examples/.