Skip to content

CLI reference

ragna

Usage: ragna [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version          Show version and exit.                                    │
│ --help             Show this message and exit.                               │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ api      Start the REST API.                                                 │
│ check    Check the availability of components.                               │
│ init     Start a wizard to build a Ragna configuration interactively.        │
│ ui       Start the UI.                                                       │
│ worker   Start workers.                                                      │
╰──────────────────────────────────────────────────────────────────────────────╯

ragna init

Usage: ragna init [OPTIONS]

Start a wizard to build a Ragna configuration interactively.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output-file  -o      OUTPUT_PATH  Write configuration to <OUTPUT_PATH>.    │
│                                     [default: (./ragna.toml)]                │
│ --force        -f                   Overwrite an existing file at            │
│                                     <OUTPUT_PATH>.                           │
│ --help                              Show this message and exit.              │
╰──────────────────────────────────────────────────────────────────────────────╯

ragna check

Usage: ragna check [OPTIONS]

Check the availability of components.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config  -c      CONFIG  Path to a Ragna configuration file.                │
│                           [env var: RAGNA_CONFIG]                            │
│                           [default: ./ragna.toml]                            │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

ragna worker

Usage: ragna worker [OPTIONS]

Start workers.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config       -c      CONFIG   Path to a Ragna configuration file.          │
│                                 [env var: RAGNA_CONFIG]                      │
│                                 [default: ./ragna.toml]                      │
│ --num-threads  -n      INTEGER  Number of worker threads to start.           │
│                                 [default: 1]                                 │
│ --help                          Show this message and exit.                  │
╰──────────────────────────────────────────────────────────────────────────────╯

ragna api

Usage: ragna api [OPTIONS]

Start the REST API.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config        -c                       CONFIG  Path to a Ragna             │
│                                                  configuration file.         │
│                                                  [env var: RAGNA_CONFIG]     │
│                                                  [default: ./ragna.toml]     │
│ --start-worker      --no-start-worker            Start a ragna worker        │
│                                                  alongside the REST API in a │
│                                                  subprocess.                 │
│                                                  [default: (Start if a       │
│                                                  non-memory queue is         │
│                                                  configured.)]               │
│ --help                                           Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯

ragna ui

Usage: ragna ui [OPTIONS]

Start the UI.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config     -c                    CONFIG  Path to a Ragna configuration     │
│                                            file.                             │
│                                            [env var: RAGNA_CONFIG]           │
│                                            [default: ./ragna.toml]           │
│ --start-api      --no-start-api            Start the ragna REST API          │
│                                            alongside the UI in a subprocess. │
│                                            [default: (Start if the API is    │
│                                            not served at the configured      │
│                                            URL.)]                            │
│ --help                                     Show this message and exit.       │
╰──────────────────────────────────────────────────────────────────────────────╯