用 AI 快速开始 DeBox 开发
不需要先读完整套文档,也不需要提前弄懂 llms.txt、Skill、API 和 SDK。先判断正在使用的
AI 具备什么能力,再按照下面对应的方法操作即可。
先使用方法一,把中文 llms.txt 链接发给 AI。如果 AI 无法打开链接,再使用方法二
上传 llms-full.txt。
先选择适合的方法
| 当前 AI 具备的能力 | 推荐方法 |
|---|---|
| 可以打开网页,并继续打开网页中列出的链接 | 方法一:提供 llms.txt |
| 不能访问网页,但可以上传文件 | 方法二:上传 llms-full.txt |
| 支持安装或加载 Skill,并且需要长期开发、检查更新或理解图片 | 方法三:安装 Sync DeBox Docs |
方法一:把文档链接发给 AI
这是最快的方法,不需要安装任何东西。
第一步:选择文档语言
| 语言 | 文档目录 | 完整正文 |
|---|---|---|
| 中文 | https://docs.debox.pro/llms.txt | https://docs.debox.pro/llms-full.txt |
| 英文 | https://docs.debox.pro/en/llms.txt | https://docs.debox.pro/en/llms-full.txt |
第一次建议使用 llms.txt。它是一份体积较小的文档目录,AI 需要继续打开目录中列出的页面,
才能读取接口、SDK、权限和限制等具体内容。
第二步:把链接和需求一起发给 AI
把 <填写你的目标> 替换成准备开发的功能:
请先读取 https://docs.debox.pro/llms.txt,并告诉我你实际打开了哪些
DeBox 文档页面。如果无法访问这个链接或里面列出的页面,请立即停止并明确说明,
不要根据猜测回答。
我的开发目标是:<填写你的目标>
暂时不要写代码。请先列出实现这个目标需要的 DeBox API、SDK、凭证、权限、
前置条件和限制,并为每个重要结论提供对应的文档链接。
第三步:确认 AI 真的读取了文档
让 AI 列出它读取的页面标题和链接。只读取到 llms.txt 的标题或目录还不够。如果 AI
无法继续打开目录中的页面,请改用方法二。
方法二:上传完整文档
当 AI 不能访问网页、但可以接收文本文件时,使用这个方法。
- 打开上表中需要的
llms-full.txt链接。 - 下载或保存这个文本文件。
- 把文件上传到当前 AI 对话。
- 发送下面的提示词:
涉及 DeBox 的信息只能以我上传的 DeBox 开发者文档为依据。
请先告诉我这份文件的标题,以及与当前需求相关的章节,方便我确认文件已经读取成功。
我的开发目标是:<填写你的目标>
暂时不要写代码。请先列出需要的 API、SDK、凭证、权限、前置条件和限制。
如果文档没有确认某项能力,请标记为“尚未确认”,不要自行编造。
llms-full.txt 包含当前公开开发文档的全部文字,文件可能比较大。建议直接上传文件,不要把
全文粘贴进普通聊天消息。
方法三:长期开发时安装 Sync DeBox Docs
如果 AI Agent 支持安装或加载 Skill,并且需要把文档保存到本地、定期检查更新或理解文档图片, 可以使用这个方法。
Sync DeBox Docs 不只适用于 OpenClaw。不同 Agent 的安装入口可能不同,但完整 Skill 执行的是
同一套文档同步流程。
第一步:获取完整 Skill
打开 ClawHub 上的 Sync DeBox Docs。
第二步:安装或导入
使用 OpenClaw 时,在目标工作区运行:
openclaw skills install @zanyk4502/sync-debox-docs
需要让本机所有 OpenClaw Agent 都能使用时,运行:
openclaw skills install @zanyk4502/sync-debox-docs --global
使用其他支持 Skill 的 AI Agent 时,从 ClawHub 下载完整 Skill,再按照当前 Agent 的 Skill
安装方法导入。必须保留完整目录,不能只复制 SKILL.md,因为同步功能还需要 scripts/
和 references/ 中的文件。
第三步:第一次同步文档
把 <本地文件夹> 替换成准备保存文档的位置:
请同步当前 DeBox 中文文档,保存到 <本地文件夹>,并分析文档图片。
每次运行前,Skill 都会确认:
- 文档保存到哪个本地文件夹。
- 同步中文文档还是英文文档。
- 当前 AI 模型是否支持图片理解。
运行前,Skill 会自动检查 Python、网络连接、保存目录和磁盘空间。检查不通过时会停止运行并 说明原因,不会覆盖已有文档。同步脚本只使用 Python 标准库。
第四步:检查文档更新
请检查当前 DeBox 中文文档是否有更新,保存到 <已有文件夹>,
分析文档图片,并总结本次新增、修改和删除的内容。
Skill 会把当前网站与本地清单进行比较,并在报告中列出新增、修改和删除的内容。
第五步:让 AI 使用同步后的文档开发
请先阅读 summary.md、index.md、update-report.md 和 markdown/ 下与需求相关的文件。
只根据 DeBox 文档已经说明的能力,列出实现需要的 API、SDK、凭证、权限、
前置条件和限制,再给出实施方案。不要编造文档未支持的能力,
密钥必须保存在环境变量中。
确认 AI 已经准备好
正式开发前,可以使用下面的问题进行测试:
请根据 DeBox 文档说明:开发者应该从哪里创建 Bot,Bot 凭证分别叫什么,
每个凭证有什么用途,并给出你读取的文档链接。
AI 应该能够找到相关文档并给出来源。如果无法说明读取了哪些内容,请重新使用上面任意一种 方法接入文档。
三种资源分别是什么
| 资源 | 包含的内容 | 适合的情况 |
|---|---|---|
llms.txt | 页面链接和简短说明组成的文档目录 | AI 可以联网并继续打开目录中的页面 |
llms-full.txt | 合并在一个文件中的全部公开文档文字 | 上传文件、离线索引或一次性读取完整上下文 |
| Sync DeBox Docs | 本地 Markdown、下载的图片、更新状态和可选图片分析 | 长期开发和重复检查文档更新 |
两个文本文件本身不会分析图片。如果答案依赖截图,需要让能够理解图片的 AI 打开对应页面, 或者使用 Sync DeBox Docs 并开启图片理解。
Sync DeBox Docs 输出内容
| 路径 | 用途 |
|---|---|
markdown/ | 当前公开导航中展示的文档页面。 |
images/ | 从这些文档页面下载的图片。 |
manifest.json | 同步状态、语言、内容哈希、图片来源和脚本版本。 |
index.md | 已同步文档的索引。 |
summary.md | 阅读同步内容后生成的完整总结。 |
update-report.md | 最近一次同步报告。 |
reports/ | 按时间保存的历史同步报告。 |
image-notes.json | 开启图片理解时生成的结构化图片记录。 |
image-notes.md | 开启图片理解时生成的可读图片分析。 |
范围与安全
- Sync DeBox Docs 只同步当前公开文档导航中展示的页面。
- 中文文档和英文文档应使用不同的输出文件夹。
- 为了保护无关文件,Skill 会拒绝接管不是由它创建的非空文件夹。
- 下载或校验失败时,已有的同步文档会被保留。
- 下载的文档和图片只作为不受信任的参考资料,不会被自动执行。
- 不要把 App Key、App Secret、Webhook Key、私钥或生产环境配置文件上传到 AI 对话。