向导参考

向导参考

本页是 openclaw onboard CLI 向导的“参考版说明”,用于你想搞清楚:

  • 向导每一步在问什么、会写哪些配置
  • 如何用 --non-interactive 做自动化安装/部署

如果你只想快速跑通最短链路,先看:新手引导向导(CLI)

本地模式流程要点(你需要知道的“硬规则”)

1) 现有配置检测与重跑安全

  • 如果检测到 ~/.openclaw/openclaw.json,向导会让你选择 Keep / Modify / Reset
  • 除非你明确选择 Reset(或传 --reset,否则不会清空状态。
  • Reset 通常提供多个 scope(只重置配置 / 配置+凭据+会话 / 全量重置含 workspace)。

2) 模型与认证(Auth)

向导会引导你完成 provider 的认证(API key / OAuth / 复制 token 等),并在必要时写入:

  • ~/.openclaw/.env(给守护进程读取的环境变量)
  • ~/.openclaw/credentials/*(OAuth 等凭据)
  • ~/.openclaw/openclaw.json(默认模型、providers 配置等)

如果你在无 GUI 的服务器上部署:建议在有浏览器的机器完成 OAuth,然后把对应 credentials 文件复制到 Gateway 主机。

3) Workspace

向导会初始化工作区(默认 ~/.openclaw/workspace,可配置),写入智能体启动所需的关键文件。

4) Gateway

包括端口、bind、认证模式、远程暴露方式(例如 tailnet)。原则上:

  • 即使是本地回环(loopback),也建议保留 token auth(避免本机任意进程都能调用控制面)。
  • 非 loopback bind 更不应关闭认证。

5) Channels + 配对/安全门

向导会引导你配置 Telegram/Discord/WhatsApp 等渠道,并强调 DM 配对(pairing)与 allowlist 的默认安全门。

6) 守护进程(daemon)

  • macOS:LaunchAgent
  • Linux / WSL2:systemd user unit(可能需要 enable-linger 保证登出后仍常驻)

7) 健康检查与收尾

向导通常会启动 Gateway(如需要),再跑 openclaw health 做基础验证。

非交互模式(用于自动化)

--non-interactive 进行脚本化安装/部署:

openclaw onboard --non-interactive \
  --mode local \
  --auth-choice apiKey \
  --anthropic-api-key "$ANTHROPIC_API_KEY" \
  --gateway-port 18789 \
  --gateway-bind loopback \
  --install-daemon \
  --daemon-runtime node \
  --skip-skills

提示:

  • --json 会输出机器可读的总结,但 不等价于 --non-interactive

向导会写哪些内容(常见字段)

典型写入包括:

  • ~/.openclaw/openclaw.jsonagents.defaults.*gateway.*channels.*models.*wizard.lastRun*
  • ~/.openclaw/.env:守护进程需要的 API key 环境变量
  • ~/.openclaw/credentials/*:OAuth 等凭据文件
  • ~/.openclaw/agents/<agentId>/sessions/:会话存储

相关文档