Onboard CLI

Interactive wizard to set up the gateway, workspace, and skills

The onboard command is an interactive wizard that guides you through setting up SimpleClaw, including gateway configuration, workspace setup, and skills installation.

Command

simpleclaw onboard

Options

--workspace · string

Agent workspace directory (default: ~/.simpleclaw/workspace)

--reset · boolean

Reset config, credentials, sessions, and workspace before running wizard

--non-interactive · boolean

Run without prompts

--accept-risk · boolean

Acknowledge that agents are powerful and full system access is risky (required for --non-interactive)

Wizard Flow

--flow · string

Wizard flow: quickstart, advanced, or manual

--mode · string

Wizard mode: local or remote

Authentication

--auth-choice · string

Authentication choice (provider-specific)

--token-provider · string

Token provider id (non-interactive; used with --auth-choice token)

--token · string

Token value (non-interactive; used with --auth-choice token)

--token-profile-id · string

Auth profile id (non-interactive; default: <provider>:manual)

--token-expires-in · string

Optional token expiry duration (e.g., 365d, 12h)

Provider API Keys

--anthropic-api-key · string

Anthropic API key

--openai-api-key · string

OpenAI API key

--mistral-api-key · string

Mistral API key

--openrouter-api-key · string

OpenRouter API key

--kilocode-api-key · string

Kilocode API key

--gemini-api-key · string

Google Gemini API key

--xai-api-key · string

xAI API key

--together-api-key · string

Together AI API key

--huggingface-api-key · string

Hugging Face API key

Additional provider flags are available for other supported providers.

Custom Provider

--custom-base-url · string

Custom provider base URL

--custom-api-key · string

Custom provider API key (optional)

--custom-model-id · string

Custom provider model ID

--custom-provider-id · string

Custom provider ID (optional; auto-derived by default)

--custom-compatibility · string

Custom provider API compatibility: openai or anthropic (default: openai)

Gateway Configuration

--gateway-port · number

Gateway port

--gateway-bind · string

Gateway bind mode: loopback, tailnet, lan, auto, or custom

--gateway-auth · string

Gateway auth mode: token or password

--gateway-token · string

Gateway token (token auth)

--gateway-password · string

Gateway password (password auth)

Remote Gateway

--remote-url · string

Remote Gateway WebSocket URL

--remote-token · string

Remote Gateway token (optional)

Tailscale

--tailscale · string

Tailscale mode: off, serve, or funnel

--tailscale-reset-on-exit · boolean

Reset tailscale serve/funnel on exit

Daemon/Service

--install-daemon · boolean

Install gateway service

--no-install-daemon · boolean

Skip gateway service install

--skip-daemon · boolean

Skip gateway service install

--daemon-runtime · string

Daemon runtime: node or bun

Skip Options

--skip-channels · boolean

Skip channel setup

--skip-skills · boolean

Skip skills setup

--skip-health · boolean

Skip health check

--skip-ui · boolean

Skip Control UI/TUI prompts

Other Options

--node-manager · string

Node manager for skills: npm, pnpm, or bun

--json · boolean

Output JSON summary

Examples

# Run interactive onboarding wizard
simpleclaw onboard

# Quick non-interactive setup with Anthropic
simpleclaw onboard --non-interactive --accept-risk --anthropic-api-key <key> --flow quickstart

# Custom workspace location
simpleclaw onboard --workspace ~/my-agent-workspace

# Reset and re-run onboarding
simpleclaw onboard --reset

# Remote gateway mode
simpleclaw onboard --mode remote --remote-url ws://gateway-host:8080

# Skip channels and skills
simpleclaw onboard --skip-channels --skip-skills

Non-Interactive Setup

For automated or scripted setups, use --non-interactive with --accept-risk and required flags:

simpleclaw onboard \
  --non-interactive \
  --accept-risk \
  --flow quickstart \
  --anthropic-api-key <key> \
  --gateway-port 8080 \
  --gateway-auth token \
  --install-daemon