Cli 导读

在终端里直接搜文档,不用切浏览器

`openclaw docs` 让你在命令行里实时搜索官方文档索引,输入关键词就能看到匹配结果。最常用的场景是查某个具体配置项或命令的用法,比如 `openclaw docs sandbox allowHostControl`。注意搜索词会发往在线索引,离线环境不可用。

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

在终端里直接搜文档,不用切浏览器

`openclaw docs` 让你在命令行里实时搜索官方文档索引,输入关键词就能看到匹配结果。最常用的场景是查某个具体配置项或命令的用法,比如 `openclaw docs sandbox allowHostControl`。注意搜索词会发往在线索引,离线环境不可用。

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

第一站

🧭 先把它想成“书架上的总目录”

官方说得很直白:Docs Directory 是一个 curated index。意思就是它帮你挑好了最该先看的门牌,不让你在整个站里乱撞。

📚 curated index

像图书馆门口的总目录牌。它不把每本书都讲一遍,只告诉你哪一排放的是什么。

🏁 新人先去哪

如果你是新来的,官方先让你去 Getting Started,而不是直接扎进深水区。

🧠 为什么需要这页

因为 OpenClaw 文档很多。没有总目录,就会像走进一个全是门的走廊,不知道该推哪一扇。

⭐ 先记一句

Docs 页面不是正文,它是整座文档城的地图牌。

第二站

🚪 Start here 这一栏,就是“先吃前菜,再吃主菜”

官方把最该先看的东西都放在最前面。你可以把它理解成:先看怎么上手,再看怎么配置,再看怎么查问题。

🌱

Getting Started

像第一次把灯点亮。先让系统跑起来,先别急着折腾细节。

🧰

Configuration

像给机器穿衣服。等能动了,再慢慢把细节配好。

🎛

Slash commands

像给前台装遥控按钮。你要知道 OpenClaw 能被怎样指挥。

🔁

Updating and rollback

像教你怎么往前走,也怎么退一步。更新会发生,回滚也要会。

第三站

💬 Providers and UX 这一栏,像“和人打交道的门”

这一组链接很像 OpenClaw 的对外窗口。消息从哪里进来,用户从哪个界面看见它,基本都在这里。

📱 WebChat / Control UI

像手机和浏览器里的前台窗口。它们是人真正和系统说话的地方。

💬 Telegram / Discord / WhatsApp

像不同的门铃。你从哪扇门敲进来,OpenClaw 就从哪儿接住你。

🧩 Plugins / companion apps

像给系统加新把手、新接口、新外壳。它们不是主线路,但能把体验补完整。

📌 这一栏的意思

如果你关心“人怎么看到 OpenClaw、怎么把消息送进来”,先看这一组。

第四站

🧠 Operations and safety,像“这台机器怎么活得久”

这组页面不是教你怎么玩,而是教你怎么不把它玩坏。它们负责会话、自动化、权限、排错。

🧵 Sessions

像一个个正在讲故事的小房间。每个会话都有自己的上下文和记忆。

🕰 Cron jobs / webhooks

像定时铃和门铃。事情到了点,或者外面有人敲门,系统就知道该动了。

🛡 Security / troubleshooting

像门锁和维修手册。门怎么锁、坏了怎么修,这两块都得会看。

🎈 这栏的核心

系统不只是能跑,还要能管、能守、能修。

第五站

🪜 Docs hubs 这块更像“全城总地图”

如果 Docs Directory 是精选目录,那 Docs hubs 就是更大的全景地图。它把所有入口都按区域摆开了。

🏁

Start here

像新手区。先从这里摸方向。

🏗

Installation + updates

像搭房子和修房子。先装,再更新。

🧠

Core concepts

像认识这座城的地形。架构、会话、流式、队列都在这里。

🔌

Extensions + plugins

像外接零件区。想加能力,就从这里找。

第六站

📚 这个页面最值钱的,不是信息量,而是导航顺序

官方把页面按用途排好了。先入门,再安装,再理解原理,再去扩展。这种顺序很像陪人走路,不会一上来就扔进迷宫。

🟢 先看什么

先看 Getting Started、Docs hubs、Configuration、Slash commands。

🟡 再看什么

再看 Channels、Plugins、Sessions、Web surfaces、Security。

🔵 最后看什么

最后才去啃更深的 reference、platform pages 和专项排错页。

🎈 一句话收住

Docs 页是整套文档的门口总览,帮你先找到路,再挑具体门进去。