Skip to content
J.A.R.V.I.S.

CLI Commands

The jarvis CLI is the operational entry point for the daemon.

Command Summary

Section titled “Command Summary”

The current shipped commands are:

  • jarvis start
  • jarvis stop
  • jarvis restart
  • jarvis status
  • jarvis logs
  • jarvis update
  • jarvis onboard
  • jarvis doctor
  • jarvis version
  • jarvis help

jarvis start

Section titled “jarvis start”

Starts the daemon.

Terminal window
jarvis start
jarvis start -d
jarvis start --port 8080
jarvis start --no-open

Flags:

  • -d, --detach: run as a background daemon
  • --port <N>: override the daemon port
  • --no-open: do not open the dashboard automatically

Notes:

  • By default, jarvis start runs in the foreground and acquires the daemon lock directly
  • jarvis start -d or jarvis start --detach spawns a background child and writes logs to the daemon log file

jarvis stop

Section titled “jarvis stop”

Stops the running daemon gracefully.

Terminal window
jarvis stop

If the process does not exit cleanly, the CLI escalates to a hard kill after a short wait.

jarvis restart

Section titled “jarvis restart”

Stops the daemon if it is running, then starts it again.

Terminal window
jarvis restart
jarvis restart --port 8080

jarvis status

Section titled “jarvis status”

Shows whether the daemon is currently running.

Terminal window
jarvis status

When running, it also prints the dashboard URL.

jarvis logs

Section titled “jarvis logs”

Shows the daemon log file.

Terminal window
jarvis logs
jarvis logs -f
jarvis logs -n 200

Flags:

  • -f, --follow: follow log output live
  • -n, --lines <N>: number of lines to show

jarvis onboard

Section titled “jarvis onboard”

Runs the interactive setup wizard.

Terminal window
jarvis onboard

Use this for first-time setup or whenever you want to reconfigure the basics interactively.

jarvis doctor

Section titled “jarvis doctor”

Runs environment and connectivity checks.

Terminal window
jarvis doctor

Use this when:

  • The daemon will not start
  • A provider is misbehaving
  • The dashboard cannot connect
  • You are not sure whether your environment is configured correctly

jarvis update

Section titled “jarvis update”

Updates JARVIS to the latest version.

Terminal window
jarvis update

jarvis version

Section titled “jarvis version”

Prints the installed version.

Terminal window
jarvis version

jarvis help

Section titled “jarvis help”

Shows built-in help text.

Terminal window
jarvis help

Common CLI Flows

Section titled “Common CLI Flows”

First-time setup

Section titled “First-time setup”
Terminal window
jarvis onboard
jarvis start

Start in background and watch logs

Section titled “Start in background and watch logs”
Terminal window
jarvis start -d
jarvis logs -f

Diagnose a broken setup

Section titled “Diagnose a broken setup”
Terminal window
jarvis doctor
jarvis status
jarvis logs -n 200

Video Tutorial Placeholder

Section titled “Video Tutorial Placeholder”

Video tutorial placeholder: installing JARVIS and using the CLI end to end.

Add your future video link here.