简要总结
gateway
这页说明书是讲一个叫“Gateway”的小工具的。你可以把它想象成一个“传话小喇叭”,它能让你的电脑和其他电脑或者软件互相说话。这页会告诉你怎么把这个小喇叭打开、怎么检查它是不是在工作、还有怎么用一些特别的“小咒语”(命令)来指挥它。如果你想让你的电脑和别人一起玩,或者想让别的软件和你电脑上的小喇叭聊天,就可以看看这页。
五岁小孩版解释
这个“传话小喇叭”(Gateway)是 OpenClaw 的一个特别工具,它就像一个专门用来传递消息的服务器。这页说明书会教你一些指挥它的“小咒语”。
首先,怎么打开这个小喇叭? 要打开它,你需要在电脑的“小黑框”(终端)里输入一个简单的咒语。就像这样:
- 打开小喇叭:输入
openclaw gateway或者openclaw gateway run,然后按回车。- 这里要小心哦!在打开它之前,通常需要先在电脑的一个叫
~/.openclaw/openclaw.json的设置文件里,写上gateway.mode=local这句话。如果你还没写,又想先试试看,可以在咒语后面加上--allow-unconfigured这个“特别通行证”。 - 这个小喇叭很安全,它不会随便让外面的电脑连接进来,除非你告诉它“可以”。
- 如果你想让它重新启动一下,可以给它发一个叫
SIGUSR1的信号(就像拍拍它的肩膀)。如果你想关掉它,就发SIGINT或SIGTERM信号(就像说“再见”)。
- 这里要小心哦!在打开它之前,通常需要先在电脑的一个叫
打开小喇叭时,可以加一些“调料”(选项): 你可以告诉小喇叭一些细节,比如:
- 让它用哪个“门”(端口)来听消息:加上
--port <门牌号>,比如--port 18789。 - 让它听谁说话:加上
--bind <loopback|lan|tailnet|auto|custom>,告诉它只听自己电脑的、听家里网络的,还是听特定网络的。 - 怎么证明你是它的主人(身份验证):可以用
--auth <token|password>来选方式,然后用--token <你的令牌>或--password <你的密码>来告诉它密码。注意哦,直接把密码写在命令里可能会被别人看到,更安全的方法是用--password-file <密码文件路径>从文件里读密码。 - 其他有用的“调料”还有
--force(强行开始)、--verbose(说更多话让你知道它在干嘛)等等。
然后,怎么知道小喇叭是不是在好好工作呢? 我们有几种“检查咒语”:
- 检查健康:输入
openclaw gateway health --url ws://127.0.0.1:18789。这就像问它:“嘿,你还好吗?” - 查看状态:输入
openclaw gateway status。这会告诉你小喇叭这个“服务”有没有在后台运行,还会试着和它聊聊天(RPC探测)来确认。你可以加--json让它用机器能看懂的方式回答,或者加--no-probe只检查服务不聊天。 - 全面探测:输入
openclaw gateway probe。这个咒语会检查所有它能找到的小喇叭,包括你设置好的远程小喇叭和本地的小喇叭,然后把它们都告诉你。如果你想通过一个叫 SSH 的“秘密通道”去检查另一台电脑上的小喇叭,可以加上--ssh user@那台电脑的地址。
你还可以直接和小喇叭“说悄悄话”(调用RPC):
用 openclaw gateway call <方法名> 这个咒语,后面跟上你想问的事情,比如 status(状态)或者 logs.tail(看看最近的日志)。
怎么安装和管理小喇叭这个“服务”? 你可以像安装一个一直运行的小精灵一样安装它:
- 安装服务:
openclaw gateway install - 启动服务:
openclaw gateway start - 停止服务:
openclaw gateway stop - 重启服务:
openclaw gateway restart - 卸载服务:
openclaw gateway uninstall安装的时候,你也可以告诉它用哪个门(--port)、用哪个令牌(--token)等等。这里要特别注意身份验证的设置,如果没设置好,安装可能会失败。
最后,怎么找到附近的其他小喇叭? 小喇叭们如果打开了“广播”功能(默认是打开的),就会发出“我在这里”的信号。你可以用这个咒语来找到它们:
openclaw gateway discover这个咒语会在你的家庭网络里,或者你指定的更大范围的网络里,寻找那些正在广播的小喇叭。你可以用--timeout <毫秒数>告诉它找多久,或者用--json让它把找到的结果整理得整整齐齐。