配置 Schema (Archive)

Archived original-language source from the legacy CrabClaw docs. This page is intentionally not machine-translated.

本页是 crabclaw onboard 的完整参考。 简短指南请见 引导向导 (CLI)。

What the wizard does

Local mode (default) walks you through:

• Model and auth setup (OpenAI Code subscription OAuth, Anthropic API key or setup token, plus MiniMax, GLM, Moonshot, and AI Gateway options)
• Workspace location and bootstrap files
• Gateway settings (port, bind, auth, tailscale)
• Channels and providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost plugin, Signal)
• Daemon install (LaunchAgent or systemd user unit)
• Health check
• Skills setup

Remote mode configures this machine to connect to a gateway elsewhere. It does not install or modify anything on the remote host.

Local flow details

Existing config detection

• If ~/.crabclaw/crabclaw.json exists, choose Keep, Modify, or Reset.
• Re-running the wizard does not wipe anything unless you explicitly choose Reset (or pass --reset).
• If config is invalid or contains legacy keys, the wizard stops and asks you to run crabclaw doctor before continuing.
• Reset uses trash and offers scopes:
  • Config only
  • Config + credentials + sessions
  • Full reset (also removes workspace)

Model and auth

• Full option matrix is in Auth and model options.

Workspace

• Default ~/.crabclaw/workspace (configurable).
• Seeds workspace files needed for first-run bootstrap ritual.
• Workspace layout: Agent workspace.

Gateway

• Prompts for port, bind, auth mode, and tailscale exposure.
• Recommended: keep token auth enabled even for loopback so local WS clients must authenticate.
• Disable auth only if you fully trust every local process.
• Non-loopback binds still require auth.

Channels

• WhatsApp: optional QR login
• Telegram: bot token
• Discord: bot token
• Google Chat: service account JSON + webhook audience
• Mattermost plugin: bot token + base URL
• Signal: optional signal-cli install + account config
• BlueBubbles: recommended for iMessage; server URL + password + webhook
• iMessage: legacy imsg CLI path + DB access
• DM security: default is pairing. First DM sends a code; approve via crabclaw pairing approve <channel> <code> or use allowlists.

Daemon install

• macOS: LaunchAgent
  • 需要已登录的用户会话；对于无头模式，使用自定义 LaunchDaemon（未随附）。
• Linux 和 Windows (WSL2): systemd 用户服务单元
  • 向导尝试 loginctl enable-linger <user>，使 Gateway 在注销后仍然运行。
  • 可能提示 sudo（写入 /var/lib/systemd/linger）；先尝试无 sudo 执行。
• 守护进程运行 Go Gateway (acosmi) 二进制。

Health check

• Starts gateway (if needed) and runs crabclaw health.
• crabclaw status --deep adds gateway health probes to status output.

Skills

• 读取可用技能并检查要求。
• 安装可选依赖（部分在 macOS 上使用 Homebrew）。

Finish

• Summary and next steps, including iOS, Android, and macOS app options.

Note: If no GUI is detected, the wizard prints SSH port-forward instructions for the Control UI instead of opening a browser. If Control UI assets are missing, the wizard attempts to build them; fallback is pnpm ui:build (auto-installs UI deps).

Remote mode details

Remote mode configures this machine to connect to a gateway elsewhere.

Info: Remote mode does not install or modify anything on the remote host.

What you set:

• Remote gateway URL (ws://...)
• Token if remote gateway auth is required (recommended)

Note: - If gateway is loopback-only, use SSH tunneling or a tailnet.

• Discovery hints:
  • macOS: Bonjour (dns-sd)
  • Linux: Avahi (avahi-browse)

Auth and model options

Model behavior:

• Pick default model from detected options, or enter provider and model manually.
• Wizard runs a model check and warns if the configured model is unknown or missing auth.

Credential and profile paths:

• OAuth credentials: ~/.crabclaw/credentials/oauth.json
• Auth profiles (API keys + OAuth): ~/.crabclaw/agents/<agentId>/agent/auth-profiles.json

Note: Headless and server tip: complete OAuth on a machine with a browser, then copy ~/.crabclaw/credentials/oauth.json (or $CRABCLAW_STATE_DIR/credentials/oauth.json) to the gateway host.

Outputs and internals

Typical fields in ~/.crabclaw/crabclaw.json:

• agents.defaults.workspace
• agents.defaults.model / models.providers (if Minimax chosen)
• gateway.* (mode, bind, auth, tailscale)
• channels.telegram.botToken, channels.discord.token, channels.signal.*, channels.imessage.*
• Channel allowlists (Slack, Discord, Matrix, Microsoft Teams) when you opt in during prompts (names resolve to IDs when possible)
• skills.install.nodeManager
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

crabclaw agents add writes agents.list[] and optional bindings.

WhatsApp credentials go under ~/.crabclaw/credentials/whatsapp/<accountId>/. Sessions are stored under ~/.crabclaw/agents/<agentId>/sessions/.

Note: Some channels are delivered as plugins. When selected during onboarding, the wizard prompts to install the plugin (npm or local path) before channel configuration.

Gateway wizard RPC:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

Clients (macOS app and Control UI) can render steps without re-implementing onboarding logic.

Signal setup behavior:

• Downloads the appropriate release asset
• Stores it under ~/.crabclaw/tools/signal-cli/<version>/
• Writes channels.signal.cliPath in config
• JVM builds require Java 21
• Native builds are used when available
• Windows uses WSL2 and follows Linux signal-cli flow inside WSL

Related docs

• Onboarding hub: Onboarding Wizard (CLI)
• Automation and scripts: CLI Automation
• Command reference: crabclaw onboard