Authentication
Zirkabot supports OAuth and API keys for model providers. For Anthropic
accounts, we recommend using an API key. Zirkabot can also reuse Claude Code
credentials, including the long‑lived token created by claude setup-token.
See /concepts/oauth for the full OAuth flow and storage layout.
Recommended Anthropic setup (API key)
If you’re using Anthropic directly, use an API key.
- Create an API key in the Anthropic Console.
- Put it on the gateway host (the machine running
zirkabot gateway).
export ANTHROPIC_API_KEY="..."
zirkabot models status
- If the Gateway runs under systemd/launchd, prefer putting the key in
~/.zirkabot/.envso the daemon can read it:
cat >> ~/.zirkabot/.env <<'EOF'
ANTHROPIC_API_KEY=...
EOF
Then restart the daemon (or restart your Gateway process) and re-check:
zirkabot models status
zirkabot doctor
If you’d rather not manage env vars yourself, the onboarding wizard can store
API keys for daemon use: zirkabot onboard.
See Help for details on env inheritance (env.shellEnv,
~/.zirkabot/.env, systemd/launchd).
Anthropic: Claude Code CLI setup-token (supported)
For Anthropic, the recommended path is an API key. If you’re already using Claude Code CLI, the setup-token flow is also supported. Run it on the gateway host:
claude setup-token
Then verify and sync into Zirkabot:
zirkabot models status
zirkabot doctor
This should create (or refresh) an auth profile like anthropic:claude-cli in
the agent auth store.
Zirkabot config sets auth.profiles["anthropic:claude-cli"].mode to "oauth" so
the profile accepts both OAuth and setup-token credentials. Older configs that
used "token" are auto-migrated on load.
If you see an Anthropic error like:
This credential is only authorized for use with Claude Code and cannot be used for other API requests.
…use an Anthropic API key instead.
Alternative: run the wrapper (also updates Zirkabot config):
zirkabot models auth setup-token --provider anthropic
Manual token entry (any provider; writes auth-profiles.json + updates config):
zirkabot models auth paste-token --provider anthropic
zirkabot models auth paste-token --provider openrouter
Automation-friendly check (exit 1 when expired/missing, 2 when expiring):
zirkabot models status --check
Optional ops scripts (systemd/Termux) are documented here: /automation/auth-monitoring
zirkabot models status loads Claude Code credentials into Zirkabot’s
auth-profiles.json and shows expiry (warns within 24h by default).
zirkabot doctor also performs the sync when it runs.
claude setup-tokenrequires an interactive TTY.
Checking model auth status
zirkabot models status
zirkabot doctor
Controlling which credential is used
Per-session (chat command)
Use /model <alias-or-id>@<profileId> to pin a specific provider credential for the current session (example profile ids: anthropic:claude-cli, anthropic:default).
Use /model (or /model list) for a compact picker; use /model status for the full view (candidates + next auth profile, plus provider endpoint details when configured).
Per-agent (CLI override)
Set an explicit auth profile order override for an agent (stored in that agent’s auth-profiles.json):
zirkabot models auth order get --provider anthropic
zirkabot models auth order set --provider anthropic anthropic:claude-cli
zirkabot models auth order clear --provider anthropic
Use --agent <id> to target a specific agent; omit it to use the configured default agent.
How sync works
- Claude Code stores credentials in
~/.claude/.credentials.json(or Keychain on macOS). - Zirkabot syncs those into
~/.zirkabot/agents/<agentId>/agent/auth-profiles.jsonwhen the auth store is loaded. - Refreshable OAuth profiles can be refreshed automatically on use. Static token profiles (including Claude Code CLI setup-token) are not refreshable by Zirkabot.
Troubleshooting
“No credentials found”
If the Anthropic token profile is missing, run claude setup-token on the
gateway host, then re-check:
zirkabot models status
Token expiring/expired
Run zirkabot models status to confirm which profile is expiring. If the profile
is anthropic:claude-cli, rerun claude setup-token.
Requirements
- Claude Max or Pro subscription (for
claude setup-token) - Claude Code CLI installed (
claudecommand available)