本文说明:很多用户安装 OpenClaw 时被众多命令搞蒙——onboard、setup、configure 各有什么用,执行顺序是什么?本文从零开始,逐条解答所有安装配置相关命令,包括 onboard(引导向导)、setup(高级安装)、configure(交互配置)、docs(文档命令)四大命令的所有用法。
一、安装配置命令关系全览
💡 标准安装流程(推荐顺序)
二、openclaw onboard 命令完整详解
openclaw onboard [--flow] [--mode] [--install-daemon]
引导向导
Q:onboard 和 onboard --install-daemon 有什么区别?
openclaw onboard 只配置认证和基本参数,不安装系统服务(Gateway 需要手动启动)。openclaw onboard --install-daemon 额外将 Gateway 注册为系统守护进程(macOS 用 launchd,Linux 用 systemd),系统重启后 Gateway 自动运行。推荐新用户用带 --install-daemon 的版本。
Q:--flow quickstart 和 --flow manual 分别适合什么场景?
--flow quickstart(默认):最小化配置,自动生成 Gateway Token,适合快速上手;--flow manual(等同 advanced):完整向导,可手动设置端口、绑定地址、认证方式等,适合需要精细控制的用户(如部署在服务器上)。
Q:--mode remote 是什么意思?什么时候用?
默认 onboard 配置本机 Gateway。openclaw onboard --mode remote --remote-url ws://gateway-host:18789 配置连接到远程 Gateway(Gateway 跑在另一台机器上)。适合:Gateway 部署在服务器/VPS,本地只运行 CLI 客户端的场景。
Q:如何非交互式自动化安装(CI/脚本中)?
使用 --non-interactive 参数配合其他参数。例如自定义 API 端点:
openclaw onboard --non-interactive --auth-choice custom-api-key --custom-base-url "https://api.example.com/v1" --custom-model-id "my-model" --custom-api-key "$MY_KEY"
注意:--json 不等于非交互模式,必须显式加 --non-interactive。
Q:onboard 支持哪些 AI 认证方式(--auth-choice)?
主要选项:anthropic(Claude API)、openai(OpenAI API)、zai-api-key(Z.AI,自动选最优端点)、zai-coding-global/zai-coding-cn(GLM Coding Plan)、custom-api-key(任意 OpenAI/Anthropic 兼容端点)。中国用户推荐 zai-cn 或 custom-api-key 接入国内代理。
Q:onboard 完成后的 follow-up 命令是什么?
onboard 完成后建议:1. openclaw configure 进一步精细配置;2. openclaw agents add <name> 添加额外 Agent;3. openclaw channels login 配置 WhatsApp/Telegram 等频道;4. openclaw dashboard 打开 Web 控制台验证运行状态。
Q:重新运行 onboard 会覆盖现有配置吗?
会部分覆盖。onboard 会重写 ~/.openclaw/openclaw.json 中的 auth 和 gateway 相关字段。如果你已有频道配置和自定义 Skills,建议先备份配置文件(cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.bak),或者用 openclaw configure 替代(只修改特定字段)。
三、openclaw setup 命令详解
openclaw setup [install|uninstall|status]
系统服务管理
Q:setup install 和 onboard --install-daemon 有什么区别?
openclaw setup install 是独立命令,专门用于安装/卸载系统守护进程,不涉及 API Key 配置。onboard --install-daemon 是在引导向导完成后顺带安装。如果你已经 onboard 过但忘记安装 Daemon,直接运行 openclaw setup install 即可。
Q:setup status 显示什么?Gateway 服务健康吗?
显示系统守护进程的运行状态:是否已安装、当前是否运行中(Running/Stopped)、PID、最近的日志。如果显示 Stopped,说明 Gateway 没有在后台自动运行,需要手动 openclaw gateway start 或检查 setup 是否正确安装。
Q:在 Linux 服务器上如何让 Gateway 开机自启?
运行 openclaw setup install,它会自动创建 systemd service 文件(/etc/systemd/system/openclaw.service)并 enable。之后用 systemctl status openclaw 查看状态,journalctl -u openclaw -f 查看日志。Docker 部署则在 docker-compose.yml 中设置 restart: always。
Q:setup uninstall 会删除配置和数据吗?
不会。setup uninstall 只移除系统服务注册(launchd plist 或 systemd service),不删除 ~/.openclaw/ 目录(配置、记忆、会话数据均保留)。如果要彻底卸载,还需要额外运行 openclaw uninstall 命令。
四、openclaw configure 命令详解
openclaw configure [--section models|channels|...]
交互配置向导
Q:configure 和 onboard 的核心区别是什么?什么时候用 configure?
onboard 是首次完整安装向导(含 Gateway 服务配置);configure 是修改已有配置的向导(不重装 Gateway)。使用场景:更换 API Key、添加新频道(Slack/Discord/Matrix)、修改模型白名单。等价于 openclaw config(无子命令时打开同一向导)。
Q:--section 参数怎么用?支持哪些 section?
openclaw configure --section models 只进入模型配置段;--section channels 只配置频道。支持:models(模型白名单多选)、channels(Slack/Discord/Matrix等,含频道ID解析)、auth(API Key)。多个 section 用多个参数:--section models --section channels。
Q:configure 修改了配置后需要重启 Gateway 吗?
大多数配置需要重启:openclaw gateway restart(或 setup uninstall + install)使新配置生效。但 Skills 文件和 Memory 文件的变更可以通过 openclaw system reload 热加载而不重启。Channel token 变更(如新的 Bot Token)必须重启。
Q:configure 的 models 部分多选模型白名单有什么用?
白名单决定用户在聊天里输入 /model 时能看到和选择哪些模型。不在白名单里的模型不会出现在选择列表中。这样可以隐藏你不想让其他用户使用的昂贵模型(如 claude-opus),只暴露特定模型给频道用户。
Q:如何非交互式修改配置(脚本/自动化)?
使用 openclaw config set 和 openclaw config get 非交互式读写配置。例如:openclaw config set gateway.port 19000 修改端口,openclaw config get gateway.token 读取 Token,openclaw config unset channels.slack 删除 Slack 配置。
📁 重要配置文件路径
~/.openclaw/openclaw.json
主配置文件(Gateway、Auth、频道)
~/.openclaw/memory/
AI 记忆 Markdown 文件目录
~/.openclaw/skills/
自定义 Skills 目录
OPENCLAW_CONFIG_PATH
环境变量,覆盖默认配置文件路径
OPENCLAW_STATE_DIR
环境变量,覆盖状态数据目录
五、openclaw docs 命令详解
openclaw docs [open|search]
文档访问
Q:openclaw docs open 打开的是什么?
在默认浏览器中打开官方文档网站(docs.openclaw.ai),无需手动输入 URL。访问官方文档需要国际网络,若显示超时或无法打开,需使用 VPN07 等国际网络工具加速。
Q:docs search 是在本地搜索还是在线搜索?
openclaw docs search "关键词" 在本地缓存的文档索引中搜索,无需联网。OpenClaw 会在安装时下载文档索引,确保离线环境也能查阅。搜索结果显示匹配的文档章节和页面链接。
Q:docs 和直接访问 docs.openclaw.ai 有什么区别?
完全等效。openclaw docs open 只是快捷命令,省去记 URL 的步骤。对于习惯命令行的用户,可以不离开终端就打开文档,提高效率。文档网站还提供了 llms.txt 格式的完整文档索引(docs.openclaw.ai/llms.txt),可供 AI 工具直接读取。
六、安装相关环境变量完整参考
Q:OPENCLAW_CONFIG_PATH 在什么场景下需要设置?
多用户共享服务器时,不同用户可以设置不同的 CONFIG_PATH 指向各自的配置文件,实现配置隔离。Docker 部署时也常用此变量将配置文件挂载到容器内固定路径。
Q:OPENCLAW_STATE_DIR 和 OPENCLAW_HOME 分别控制什么?
OPENCLAW_STATE_DIR 控制运行时状态(Sessions、缓存、Sockets 等)的存储位置;OPENCLAW_HOME 设置 OpenClaw 的"家目录",用于内部路径解析。将 State 放在内存盘(如 /tmp/openclaw-state)可以提升 IO 性能。
⚠️ Q:onboard 提示 "Node.js version too old" 怎么解决?
OpenClaw 要求 Node.js 22 或更新版本。运行 node --version 确认版本。升级方法:使用 nvm install 22 && nvm use 22(推荐)或从 nodejs.org 下载最新 LTS 版本后重新安装 OpenClaw。
💡 Q:如何在 VPS 服务器上快速完成 onboard?
推荐流程:1. 安装 Node 22;2. npm i -g openclaw@latest;3. openclaw onboard --non-interactive --auth-choice anthropic --flow manual --install-daemon 配合环境变量 ANTHROPIC_API_KEY。VPS 访问 Anthropic API 需要稳定的国际网络,VPN07 的 1000Mbps 千兆带宽确保 API 调用零超时。