klea-rag¶
Interactive RAG query client.
Usage: klea-rag [OPTIONS] COMMAND [ARGS]...
Simple KLEA RAG user client
╭─ Options ──────────────────────────────────────────────────────────╮
│ --install-completion Install completion for the current │
│ shell. │
│ --show-completion Show completion for the current │
│ shell, to copy it or customize the │
│ installation. │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────╮
│ tui Klea RAG tui client (Textual) │
│ web Klea RAG web client (NiceGUI) │
╰────────────────────────────────────────────────────────────────────╯
Usage: klea-rag tui [OPTIONS]
Klea RAG tui client (Textual)
╭─ Options ──────────────────────────────────────────────────────────╮
│ --server -s TEXT KLEA RAG server (URL:port) │
│ [default: │
│ http://127.0.0.1:8005] │
│ --title -t TEXT Title for application │
│ [default: KLEA RAG] │
│ --user-id TEXT Opaque user id. Defaults to │
│ KLEA_USER_ID, else a persisted │
│ local UUID (sent only to a │
│ loopback server). │
│ --resume TEXT Resume a specific chat session │
│ by id. │
│ --continue Resume the most recently │
│ updated chat session. │
│ --cwd TEXT Working directory for the │
│ session's bundled tools │
│ (default: the current │
│ directory). │
│ --env TEXT Environment override for the │
│ bundled tools, KEY=VALUE │
│ (repeatable). The whole current │
│ environment is forwarded by │
│ default. │
│ --interpreter TEXT Python interpreter for the │
│ bundled tools (default: the │
│ interpreter running this │
│ client). │
│ --no-client-context Do not forward │
│ cwd/env/interpreter to the │
│ server. │
│ --debug Enable debug logging │
│ --profile -p TEXT Config profile name: loads │
│ <name>.json from the current │
│ directory or the config dir. │
│ Use 'template' to scaffold a │
│ new config and exit. │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────╯
Usage: klea-rag web [OPTIONS]
Klea RAG web client (NiceGUI)
╭─ Options ──────────────────────────────────────────────────────────╮
│ --server -s TEXT KLEA RAG server │
│ (URL:port) │
│ [default: │
│ http://127.0.0.1:8005] │
│ --title -t TEXT Title for application │
│ [default: KLEA RAG] │
│ --subtitle -b TEXT Subtitle shown next to │
│ title in header │
│ --disclaimer -c TEXT Disclaimer text shown in │
│ the footer │
│ [default: Answers use LLM │
│ technology and may be │
│ incorrect. Please │
│ re-confirm.] │
│ --footer TEXT Footer HTML content │
│ [default: Powered by <a │
│ href="https://github.com… │
│ --nicegui-url TEXT Host:port to bind the │
│ NiceGUI web server to │
│ [default: 0.0.0.0:7860] │
│ --storage-secret TEXT NiceGUI storage secret │
│ for session persistence │
│ [default: │
│ klea-nicegui-secret-chan… │
│ --favicon TEXT Browser-tab icon: a file │
│ path, http(s)/data URL, │
│ raw SVG or a single │
│ character. Defaults to │
│ the bundled Klea icon. │
│ --reload -r Enable auto-reload on │
│ file changes │
│ --user-id TEXT Opaque user id. Defaults │
│ to KLEA_USER_ID, else a │
│ shared host-local │
│ identity file (loopback │
│ only). │
│ --resume TEXT Open a specific chat │
│ session by id on load. │
│ --continue Open the most recently │
│ updated chat session on │
│ load. │
│ --open --no-open Open the UI in the │
│ default browser once │
│ ready (default: yes). │
│ [default: open] │
│ --debug Enable debug logging │
│ --profile -p TEXT Config profile name: │
│ loads <name>.json from │
│ the current directory or │
│ the config dir. Use │
│ 'template' to scaffold a │
│ new config and exit. │
│ --help Show this message and │
│ exit. │
╰────────────────────────────────────────────────────────────────────╯
Environment variables¶
KLEA_RAG_ENV_FILEPath to environment file (default:
rag.env).KLEA_RAG_APP_CONFIG_FILEConfig file used when
--profileis not given (from the env file, the environment, or the defaultklea_rag.json).
Pass --profile <name> to load <name>.json from the current
directory or the config directory; --profile template scaffolds a
new config. A profile only applies to a server the client spawns
itself – a server that is already running keeps its own config.