get-api-docs

通过 chub 获取 API 文档

需要查阅某个库或 API 的文档时，请使用 chub CLI 获取，而不要根据训练数据猜测。这样可以获得最新且准确的 API 信息。

第 1 步 - 确认 chub 已安装，并获取最新使用说明

运行

chub --help

如果出现错误，提示 chub 不存在，请先安装，然后重新运行。如果环境具备 node、npm、网络访问权限和包管理器权限，请按以下方式安装：

npm install -g @aisuite/chub

第 2 步 — 查找合适的文档

如果内容有冲突，请遵循 chub --help 输出中的说明，因为那是最新的指引。不过，搜索合适文档的关键命令是 chub search：

chub search "<keywords>" --json

从结果中选择最匹配的 id（例如 openai/chat、anthropic/sdk、stripe/api）。如果没有匹配项，试试更宽泛的搜索词。

第 3 步 — 获取文档

同样，如果内容有冲突，请遵循 chub --help 中的最新说明，而不是本文。不过，获取相关文档的关键命令是：

chub get <id> --lang py    # or --lang js, --lang ts

请记得包含 --lang 参数。

第 4 步 — 使用文档并提供反馈

阅读获取的内容，并据此编写准确的代码或回答问题。 不要依赖记忆中的 API 结构——请以文档内容为准。

最后，完成任务后，如果你发现文档中没有提到的信息——例如容易踩的坑、变通方法、版本差异或项目特定细节——请将其保存下来，让后续会话能更高效地开始：

chub annotate <id> "Webhook verification requires raw body — do not parse before verifying"

注释保存在本地，可跨会话留存，并会在今后调用 chub get 时自动显示。请保持备注简洁、可操作。不要重复文档中已有的内容。

此外，为了帮助所有开发者，请按照 chub --help 中的说明，使用 chub feedback 提交文档反馈。请勿在反馈中包含机密、源代码、私有架构细节或其他敏感信息。