引导向导参考
Setup Wizard(配置向导)是 OpenClaw 初次安装时的交互式引导工具。它通过一系列问答帮助用户快速完成核心配置,生成 openclaw.config.yaml。
启动向导
bash
# 首次安装自动运行
openclaw init
# 手动重新运行向导
openclaw wizard
# 以非交互模式运行(使用默认值)
openclaw wizard --defaults
# 从模板初始化
openclaw wizard --template enterprise配置流程
向导按以下顺序收集配置信息:
开始
│
├─ 1. 选择部署模式 (local / docker / cloud)
│
├─ 2. 配置 AI 模型提供商
│ ├─ OpenAI
│ ├─ Anthropic
│ ├─ DeepSeek
│ └─ 自定义 (OpenAI-compatible)
│
├─ 3. 设置消息渠道
│ ├─ Web UI
│ ├─ WhatsApp
│ ├─ Telegram
│ └─ 更多...
│
├─ 4. 配置 Agent 基础信息
│ ├─ 名称
│ ├─ 人格描述
│ └─ 默认模型
│
├─ 5. 安全设置
│ ├─ RPC 认证
│ └─ 消息加密
│
└─ 6. 生成配置文件
└─ openclaw.config.yaml决策树
部署模式选择
| 选项 | 条件 | 结果 |
|---|---|---|
local | 开发测试 | 最小配置,本地端口 |
docker | 有 Docker 环境 | 生成 docker-compose.yaml |
cloud | 生产部署 | 包含 TLS、域名配置 |
模型提供商决策
选择模型提供商
│
├─ OpenAI → 输入 API Key → 选择模型 (gpt-4o / gpt-4o-mini)
│
├─ Anthropic → 输入 API Key → 选择模型 (claude-3.5-sonnet)
│
├─ DeepSeek → 输入 API Key → 选择模型 (deepseek-chat)
│
└─ 自定义 → 输入 Base URL + API Key → 输入模型名多模型配置
向导支持配置多个模型提供商。在后续高级配置中可以设置模型路由和 Failover 策略。
默认值参考
每个配置项的默认值:
| 配置项 | 默认值 | 说明 |
|---|---|---|
gateway.host | 127.0.0.1 | 绑定地址 |
gateway.port | 18789 | 端口号 |
agent.name | main | 主 Agent 名称 |
agent.model | gpt-4o-mini | 默认模型 |
session.maxTokens | 4096 | 上下文 Token 上限 |
session.compaction | true | 启用会话压缩 |
rpc.enabled | true | 启用 RPC |
rpc.auth | true | RPC 认证 |
usage.tracking | true | 用量追踪 |
自定义向导
向导模板
提供预定义模板以简化特定场景的配置:
bash
openclaw wizard --template personal
# 最小化配置,单 Agent,Web UI 渠道bash
openclaw wizard --template enterprise
# 完整配置,多 Agent,多渠道,安全加固bash
openclaw wizard --template dev
# 调试模式开启,Mock 渠道,详细日志扩展向导步骤
插件可以向向导注入额外配置步骤:
typescript
// 在插件中注册向导步骤
export default function myPlugin(gateway) {
gateway.wizard.addStep({
name: 'my-plugin-config',
prompt: '请输入 My Plugin 的 API Key:',
type: 'password',
configPath: 'plugins.myPlugin.apiKey',
validate: (value) => value.length > 0
})
}配置文件输出
向导完成后生成的配置文件示例:
yaml
# openclaw.config.yaml (由向导生成)
gateway:
host: '127.0.0.1'
port: 18789
providers:
- name: openai
apiKey: ${OPENAI_API_KEY}
agents:
- name: main
model: gpt-4o-mini
channels:
- type: web
session:
compaction:
enabled: true
threshold: 4096
rpc:
enabled: true
auth:
type: bearer向导之后
向导生成的是基础配置。更多高级功能(多 Agent、技能、插件等)需要手动编辑配置文件。
