API 与参考资料阅读入口

OpenClaw 的“参考资料”不只是传统意义上的 HTTP API 文档。根据官方文档结构，真正需要被长期查阅的参考信息通常包括：

• CLI 与命令说明
• 配置文件与字段含义
• 模块级说明
• 帮助与诊断入口
• 版本与迁移提示

对中文用户来说，关键不是一次看完所有 reference，而是知道遇到某类问题时应该先查什么。

什么时候需要查参考资料

你已经理解概念，但需要查具体字段

例如你知道要配模型、渠道或工具，但忘记了某个字段应放在哪里，这时就该进入 reference，而不是回到入门文档。

你在排错

很多排错动作最终都要落到版本、命令、配置项和认证边界上，这些都属于参考资料范畴。

你要做自动化或团队内复用

一旦需要写脚本、写部署说明或规范团队配置，就必须以 reference 为准，而不是凭记忆操作。

建议把参考资料分成四类来看

1. 命令参考

适合查：

• 初始化命令
• 配置相关命令
• 诊断和帮助命令
• 与版本、更新、检查有关的命令

2. 配置参考

适合查：

• 配置文件结构
• 环境变量
• 模型与工具相关字段
• 认证、网关、日志和诊断参数

3. 模块参考

适合查：

• Channels 的模块边界
• Control UI / Web UI 的作用
• Hooks、Tools、Models 的扩展方式

4. 版本参考

适合查：

• 当前最新版本做了什么
• 是否有 breaking changes
• 是否需要迁移

中文站应该如何使用参考资料

中文站不适合简单复制 reference，而应该做两层转化：

1. 把 reference 转成能读懂的中文解释
2. 把关键字段和命令转成“在什么情况下该用它”

这样才能避免文档只剩参数堆砌。

一条更高效的查阅路径

如果你遇到问题，建议按这个顺序找：

1. 先看当前问题属于安装、渠道、模型还是安全
2. 再到对应 reference 查字段和命令
3. 最后结合 故障排除与诊断思路 判断根因

参考资料使用原则

• 以官方当前版本为准
• 每次升级后重新核对关键字段
• 团队内部文档不要只贴截图，最好注明版本和字段语义

下一步推荐

• 安装与环境
• 故障排除与诊断思路
• 版本迁移与升级检查单