Cli 导读

一句话完成 Gateway 初始化:选流程、填密钥、跑起来

`openclaw onboard` 是 CLI 的交互式向导,帮你快速配置本地或远程 Gateway。首次运行先选 `--flow quickstart` 跳过手动步骤;如果要用自定义 API 提供商,务必注意 `--custom-api-key` 可省略但环境变量 `CUSTOM_API_KEY` 必须存在。非交互模式用于脚本时,记得加 `--non-interactive`,光加 `--json` 不会跳过交互。

先讲这一页到底在解决什么

一句话完成 Gateway 初始化:选流程、填密钥、跑起来

`openclaw onboard` 是 CLI 的交互式向导,帮你快速配置本地或远程 Gateway。首次运行先选 `--flow quickstart` 跳过手动步骤;如果要用自定义 API 提供商,务必注意 `--custom-api-key` 可省略但环境变量 `CUSTOM_API_KEY` 必须存在。非交互模式用于脚本时,记得加 `--non-interactive`,光加 `--json` 不会跳过交互。

原文共 7 节,先看 Start Here 路径:/cli/onboard 查看官方原文

第一站

🚪 先记住四种常见开门方式

官方给的例子不多,但已经把最常见的几条路摆出来了。

1

openclaw onboard

像直接让向导带你走完整趟入门路。

2

--flow quickstart

像走一条短路。问题少,动作少,很适合先点亮。

3

--flow manual

像把所有门都自己亲手摸一遍。更慢,但更细。

4

--mode remote

像你不是住在本地小屋,而是去远处的 Gateway 新家里装门牌。

第二站

🧭 这趟旅程最像什么?像一位向导陪你选“怎么进门”

你不用一上来就把所有设置都背下来。向导会一步一步问你,像商店里有人带你挑桌子、挑灯、挑钥匙。

🪪 先选入口

是本地 Gateway,还是远程 Gateway。先决定门在哪儿。

🎟 再选钥匙

是 token、password、API key,还是更安全的 secret reference。

🏠 再选房间

配置、工作区、模型、通道,像一间间小房间让你慢慢摆好。

⭐ 一句话

onboard 不是让你记住全部答案,而是带你一个个做决定。

第三站

🏗 `quickstart` 和 `manual`,像两种搭积木方式

一个是先拼出能玩的样子,一个是把每块积木都自己挑一遍。

🧸

quickstart

像先搭一个玩具小屋。门先开着,最重要的功能先亮起来。

🧩

manual

像把每块积木都自己摆正。适合想把每个细节都看清的人。

🎯

它们不是竞争关系

quickstart 是快,manual 是细。你要的是先活起来,还是先精确摆好,自己挑。

📌

一句话

quickstart 先上手,manual 先看全。

第四站

🪟 `--mode remote` 像“去别人的院子里搭门,但门仍然要开得稳”

远程模式不是把整个东西搬走,而是让向导知道:门牌在远处,连线方式也要跟着换。

--remote-url wss://gateway-host:18789

像把新家的地址先写清楚。向导按这个地址找门。

ws:// 私网只限可信网络

像只在熟人院子里走小路。不是所有路都能这么开。

🔐 远程也要门票

门开在远处,不代表就能省掉认证。该拿的票还是要拿。

🎈 一句话

remote 不是“免门票”,只是“去远处开家门”。

第五站

🔑 你会遇到的几类钥匙,像抽屉里不同颜色的小卡片

OpenClaw 这页很像在教你识别“钥匙放哪里”和“钥匙怎么存”。

🧾

plaintext

像把钥匙直接摊在桌上。能用,但不够讲究。

📎

secret ref

像把钥匙写成一个小名牌,不把真正的钥匙明文放出来。

📦

env / file / exec

像有些钥匙藏在口袋里,有些在抽屉里,有些得现场去取。

⚠️

没拿到就别硬写

如果需要的 env 没有准备好,向导会直接停下,不会假装钥匙存在。

第六站

🧪 `--non-interactive` 像“老师不在旁边时,你得自己把答案一次填对”

这部分最适合自动化。没有人陪着问答时,你就得把每个关键答案自己提前放好。

--non-interactive

像把问答模式关掉,直接按你准备好的答案往下走。

--auth-choice ...

像先挑今天要用哪种门票:OpenAI、Anthropic、Ollama、Z.AI、Mistral,还是自定义。

--secret-input-mode ref

像把门票写成名牌,不把原票直接贴墙上。

📌 一句话

非交互模式不是更简单,而是更要求你提前准备好所有卡片。

第七站

🖥 `--install-daemon` 像“顺手把值班表也贴上去”

如果你希望 Gateway 之后一直有人守着,onboard 会帮你把守门员的排班也搞定。

🛎 装守护服务

像把这个新家交给系统服务来值夜班,不用你每次手动起。

⏳ 先等健康检查

非交互模式通常会等一个可达的本地 Gateway,确认门真的能开。

🔍 `--skip-health`

像你说“我这次只想先把家当摆进去,别急着检查看能不能住”。

🎈 一句话

install-daemon 是把“能跑”变成“长期有人值班”。

第八站

🎁 最后那两条常见后续命令,像“收尾时顺手拿钥匙,再去开下一扇门”

onboard 结束后,官方常会把你往后续配置和补 agent 的方向领。

🧰

openclaw configure

像把刚搭好的家再细调一遍,补补家具和规则。

openclaw agents add <name>

像在新家里再添一个工位,让别的角色也能进来干活。

📣

最快第一次聊天

官方也提醒你,很多时候先开 dashboard,就能最先看到一条会说话的路。

📌

一句话

onboard 不是终点,它只是把“第一天能住进去”这件事办完。

最后总结

🎈 把 openclaw onboard 压成一句话

openclaw onboard 就是带你把 OpenClaw 的新家一步步安好:先选门,再选钥匙,再选远程还是本地,最后让 Gateway 真正能开始值班。