CLI reference
ragna
Usage: ragna [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version Show version and exit. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ init Start a wizard to build a Ragna configuration interactively. │
│ check Check the availability of components. │
│ deploy Deploy Ragna REST API and web UI. │
│ corpus (Experimental) Interact with a corpus of documents. │
╰──────────────────────────────────────────────────────────────────────────────╯
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 deploy
Usage: ragna deploy [OPTIONS]
Deploy Ragna REST API and web UI.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --config -c CONFIG Path to a Ragna │
│ configuration file. │
│ [env var: │
│ RAGNA_CONFIG] │
│ [default: │
│ ./ragna.toml] │
│ --api --no-api Deploy the Ragna │
│ REST API. │
│ [default: api] │
│ --ui --no-ui Deploy the Ragna web │
│ UI. │
│ [default: ui] │
│ --ignore-unavailabl… --no-ignore-unava… Ignore components │
│ that are not │
│ available, i.e. │
│ their requirements │
│ are not met. │
│ [default: │
│ no-ignore-unavailab… │
│ --open-browser --no-open-browser Open a browser when │
│ Ragna is deployed. │
│ [default: (value of │
│ ui / no-ui)] │
│ --help Show this message │
│ and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯