Personal Jarvis / docs ← Back to site GitHub

Getting Started

First Run & Your Keys

The setup wizard, where your API keys actually live, and how to talk to Jarvis the first time.


On first launch Jarvis runs a setup wizard. It collects your own cloud API keys and writes them straight into your operating system’s credential manager — never to disk, never to a config file, never to a Jarvis server.

Bring your own keys (BYOK)

Jarvis is multi-provider by design. You can supply any subset of:

  • Anthropic / Claude
  • Google Gemini
  • xAI Grok
  • OpenAI
  • OpenRouter (a single key fronting many models)

You need at least one. Every provider class — Brain, speech-to-text, text-to-speech, vision, wake-word — keeps a cloud-reachable default path, so a GPU-less, keyless-local machine still works through the cloud providers.

Where keys are stored

LayerUsed for
OS credential managerThe real store the wizard writes to (Windows Credential Manager, macOS Keychain, Secret Service on Linux)
Environment variableOptional override, read at boot
.env fileDev-only fallback

Keys are never accepted over voice or chat — that would be a credential-leak vector through the speech logs. The wizard is the only entry point.

Re-running the wizard

python -m jarvis --wizard

First words

Once it launches, you’ll see the floating orb (or the browser UI in headless mode). Say the activation phrase supported by your selected wake-word provider, wait for the chime, and talk.

Documentation convention: [wake word] is a neutral placeholder. Replace it with the activation phrase supported by your installation; it is not the Personal Jarvis product name.

  • “[wake word], what’s on my calendar today?”
  • “[wake word], open a pull request for the changes on this branch.”
  • “[wake word], switch to Gemini.”

The last one is a first-class runtime operation — provider switching takes effect on your next command, no restart.

Useful boot commands

python -m jarvis --check        # hardware + capability analysis
python -m jarvis --plugins      # list the registered providers
python -m jarvis --debug        # console logging + config dump

See the full list under CLI reference.