Personal Jarvis / docs ← Back to site GitHub

Reference

CLI Reference

Console scripts, the python -m jarvis commands, and the desktop launcher flags.


After installation, Jarvis exposes a set of console scripts and a root CLI.

Console scripts

jarvis              # launch the tray app (or the first-run wizard)
jarvis-ask          # one-shot prompt from the command line

Root CLI — python -m jarvis

python -m jarvis --version
python -m jarvis --wizard          # re-run the setup / key wizard
python -m jarvis --check           # hardware + capability analysis
python -m jarvis --plugins         # dump the registered provider registry
python -m jarvis --debug           # console logging + config dump

Desktop launcher

python -m jarvis.ui.web.launcher             # full app: API + window + voice + orb
python -m jarvis.ui.web.launcher --headless  # API + WebSocket only, no window
python -m jarvis.ui.web.launcher --dev       # frontend from the Vite dev server

Install flags

Passed to the one-line / npx installer:

FlagEffect
--headlessNo desktop window or voice; API + WebSocket only
--with-voice-localDownload local STT/TTS/wake models on install
--no-launchInstall only; do not start
--no-wizardSkip the first-run key wizard

Environment toggles

VariableEffect
JARVIS_VOICE=0Launch without the voice pipeline
JARVIS_DEBUG=1Verbose console logging

If something refuses to boot after an install, start with python -m jarvis --check and --plugins — see troubleshooting.