简要总结
onboard
这页说明书在教你用一个叫 openclaw onboard 的魔法小助手。这个小助手会像玩游戏一样,一步步问你问题,帮你把“OpenClaw”这个工具准备好,让它能和你聊天、帮你做事。你可以用它来设置一个在你电脑里工作的“本地小门卫”,或者连接到一个远方的“远程大门卫”。
如果你第一次用 OpenClaw,或者想换一种方式连接它,就看这一页。
五岁小孩版解释
openclaw onboard 是一个互动的小向导,它会牵着你的手,帮你完成 OpenClaw 的初始设置。你可以把它想成是给新玩具装电池和开机,这样玩具才能动起来。
怎么启动这个小向导呢? 很简单,就像叫朋友的名字一样,在电脑的命令行里输入:
- 启动向导:输入
openclaw onboard,然后按回车。 - 选择快速开始:如果你想快点,可以输入
openclaw onboard --flow quickstart。它会少问几个问题,帮你自动生成一些密码。 - 选择手动设置:如果你想自己决定所有细节,可以输入
openclaw onboard --flow manual。它会问你更多问题,比如用哪个门牌号(端口)和密码。
如果你想连接一个已经存在的远程“大门卫”呢? 那也很简单:
- 告诉它连接远方:输入
openclaw onboard --mode remote --remote-url wss://gateway-host:18789。记得把wss://gateway-host:18789换成你真正的“大门卫”地址哦。 - 注意安全:如果这个远程地址是
ws://开头的(就像寄明信片,大家都能看到),那只能在非常信任的网络里用。你需要先设置一个叫OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1的环境变量,告诉小向导“我明白,我信任这个网络”。
如果我不想回答问题,想用脚本自动完成呢? 你可以用“非互动模式”,就像给机器人一张任务清单。这里有几个重要的“清单选项”:
--non-interactive:告诉小向导“别问我,按清单做”。--auth-choice:选择用哪个“钥匙供应商”,比如openai-api-key(用OpenAI的钥匙),custom-api-key(用你自己服务器的钥匙)。- 如果你选择
custom-api-key,你还需要告诉它:--custom-base-url:你的服务器地址在哪里。--custom-model-id:你想用哪个模型(比如foo-large)。--custom-api-key:你的钥匙是什么。如果这里不写,小向导会去环境变量里找一个叫CUSTOM_API_KEY的钥匙。
--secret-input-mode:选择怎么保管你的钥匙。有两种方式:plaintext:把钥匙明文写在配置文件里(像把密码写在纸上,不太安全)。ref:不直接写钥匙,而是写一个“线索”,比如“去环境变量里找叫OPENAI_API_KEY的东西”。这样更安全。用这个模式时,你必须提前把真正的钥匙放到对应的环境变量里。
关于“大门卫”的密码(令牌) 当你设置本地或远程的“门卫”时,可能需要密码:
- 你可以直接用
--gateway-token <密码>把密码写进去。 - 或者,用更安全的方式:
--gateway-token-ref-env <环境变量名>。这样只记录“去某某环境变量里找密码”。用这个方式,你必须提前把真正的密码放到那个环境变量里。 - 注意:
--gateway-token和--gateway-token-ref-env只能选一个用,不能两个都用。
一些重要的提醒
- 这个小向导有两种主要流程:
quickstart(快速,问题少)和manual(也叫advanced,手动,问题全)。 - 如果你用
--auth-choice zai-api-key,小向导会聪明地根据你的钥匙,自动选一个最好的 Z.AI 服务器地址。如果你特别想用 GLM Coding Plan 的地址,就直接选zai-coding-global或zai-coding-cn。 - 设置完成后,你可以用
openclaw dashboard命令快速打开控制面板,开始第一次聊天。 - 记住:
--json这个选项不会自动开启“非互动模式”。如果你想写脚本自动运行,一定要加上--non-interactive。