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 web UI. │
╰──────────────────────────────────────────────────────────────────────────────╯
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 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] │
│ --ignore-unavailabl… --no-ignore-unava… Ignore components │
│ that are not │
│ available, i.e. │
│ their requirements │
│ are not met. │
│ [default: │
│ no-ignore-unavailab… │
│ --help Show this message │
│ and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
ragna ui
Usage: ragna ui [OPTIONS]
Start the web 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 │
│ web UI in a │
│ subprocess. │
│ [default: (Start if │
│ the API is not │
│ served at the │
│ configured URL.)] │
│ --ignore-unavailabl… --no-ignore-unava… Ignore components │
│ that are not │
│ available, i.e. │
│ their requirements │
│ are not met. This │
│ option as no effect │
│ if --no-start-api is │
│ used. │
│ [default: │
│ no-ignore-unavailab… │
│ --open-browser --no-open-browser Open the web UI in │
│ the browser when it │
│ is started. │
│ [default: │
│ open-browser] │
│ --help Show this message │
│ and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯