Quick Start

1. Initialize

weavbot onboard

This creates WB_DATA_PATH/config.json and WB_DATA_PATH/workspace/ (default WB_DATA_PATH=~/.weavbot), then launches an interactive setup wizard that walks you through:

Provider selection — fetches known providers and models from models.dev, lets you pick a provider, model, and enter your API key
Channel configuration — configure chat channels (Telegram, Discord, Feishu, DingTalk, Slack, QQ, Wecom, Email, Mochat) by entering credentials
Dependency install — detects and offers to install ripgrep (required by the agent’s file search tool) to ~/.weavbot/bin/
Auto-start setup — configures the gateway to start automatically on login (systemd on Linux, launchd on macOS, traycli on Windows)

The wizard auto-detects your system language and displays prompts in Chinese when appropriate. Override with WB_LANG=en or WB_LANG=zh. CLI translations are now provided by the standalone weavbot.i18n package, with key namespaces such as cli.setup.* and cli.commands.* for future extension. Pickers support arrow-key navigation and type-to-filter. If realtime pickers are unavailable (for example, non-TTY terminals), onboarding automatically falls back to numbered selection mode.

Alternatively, use --set to configure values inline (repeatable, Helm-style):

weavbot onboard \
  --set providers.anthropic.apiKey=sk-ant-xxx \
  --set providers.anthropic.mode=anthropic \
  --set agents.defaults.model=claude-sonnet-4-20250514 \
  --set agents.defaults.provider=anthropic

Keys are dot-separated camelCase paths matching the JSON config structure. Values are auto-coerced (numbers, booleans, null) or treated as strings.

2. Configure

You can also edit WB_DATA_PATH/config.json directly (default ~/.weavbot/config.json) to set your API key and model.

Providers are a flat dictionary — the key is a free-form name you choose, and each entry specifies a mode ("openai" or "anthropic") plus credentials:

{
  "providers": {
    "anthropic": {
      "mode": "anthropic",
      "apiKey": "sk-ant-xxx"
    },
    "openrouter": {
      "apiKey": "sk-or-v1-xxx",
      "apiBase": "https://openrouter.ai/api/v1"
    },
    "deepseek": {
      "apiKey": "sk-xxx",
      "apiBase": "https://api.deepseek.com/v1"
    }
  },
  "agents": {
    "defaults": {
      "model": "claude-sonnet-4-20250514",
      "provider": "anthropic"
    }
  }
}

mode defaults to "openai" (OpenAI-compatible API). Set "anthropic" for native Anthropic API.
agents.defaults.provider must match a key in the providers dict.

All channel and tool options are documented in the Configuration section.

3. Run

weavbot gateway

This starts the long-running gateway that manages the agent, channels, scheduled tasks, and heartbeat.

Install

Auto-Start

CLI Reference