Skip to content

Quick Start

This guide assumes you have completed installation. If you haven’t, start there.

If you used the one-liner installer, onboarding ran automatically. If you installed manually or want to reconfigure, run it again at any time:

Terminal window
jarvis onboard

The wizard walks through:

  1. Anthropic API key — paste your key from console.anthropic.com
  2. LLM model — defaults to claude-opus-4-6, press Enter to accept
  3. Dashboard port — defaults to 3142, press Enter to accept
  4. Telegram bot token — optional, press Enter to skip for now
  5. Discord bot token — optional, press Enter to skip for now
  6. Voice — enable TTS and STT (TTS requires no API key)
  7. Autostart — install a systemd user service (Linux) or launchd plist (macOS)

Your config is saved to ~/.jarvis/config.yaml.

Terminal window
jarvis start

JARVIS launches in the background. On first start it:

  • Opens the SQLite knowledge vault at ~/.jarvis/jarvis.db
  • Starts the WebSocket server on your configured port (default 3142)
  • Auto-detects and launches Chrome or Chromium for browser control
  • Opens the dashboard in your default browser

To keep JARVIS in the foreground (useful for debugging):

Terminal window
jarvis start --foreground

The dashboard opens automatically after jarvis start. If it does not, navigate to:

http://localhost:3142

You should see the JARVIS dashboard with a chat interface ready to receive messages.

In the chat input, try a command that exercises real capabilities:

Go to news.ycombinator.com and tell me the top 5 stories right now

JARVIS will:

  1. Navigate Chrome to Hacker News
  2. Extract the page content
  3. Summarize the top 5 stories
  4. Stream the response back to you in real time

Try another that uses memory:

My name is Alex and I prefer concise answers. Remember this.

From this point on, JARVIS knows your name and preference. Ask it to confirm:

What do you know about me?

In another terminal, confirm the daemon is healthy:

Terminal window
jarvis status

Expected output:

JARVIS daemon is running
PID: 12345
Port: 3142
Uptime: 2m 14s
Memory: 87 MB
Active agents: 1
Messages today: 3
CommandDescription
jarvis startStart the daemon in the background
jarvis stopStop the daemon gracefully
jarvis restartRestart the daemon
jarvis statusShow daemon status and health
jarvis logs -fStream live logs
jarvis onboardRe-run the configuration wizard
jarvis doctorDiagnose common configuration problems
jarvis updateUpdate to the latest version
jarvis versionShow version information

See the full CLI reference for all flags and options.

Now that JARVIS is running, explore its core features: