SuperAPI AI 工具集

codex-cli-docs

写作与研究

查看项目

更新于 10-16 00:23

技能介绍

用途:作为 OpenAI Codex CLI 全部文档的单一可信来源与管理员,负责本地文档存储、抓取、发现和解析,适用于抓取文档、按关键词或自然语言查找文档、将 doc_id 解析为文件路径、维护索引元数据以及重建索引。

主要能力:规范化存储官方文档;子章节抽取以获得令牌优化的摘要;基于哈希与 404 检查的文档漂移检测;同步与维护自动化;基于关键词的文档搜索与 doc_id 解析;索引元数据(关键词、标签、别名)管理,从文件系统重建索引以应对重命名或移动。核心价值是防止链接失效、支持离线访问、优化令牌成本并提供稳定的基于 doc_id 的引用。

使用方式:常用工作流通过斜杠命令调用,如 /openai-ecosystem:docs-ops scrape(从 llms.txt 源抓取)、refresh(刷新索引与元数据)、validate(校验索引与引用一致性)、rebuild-index(强制重建搜索索引)、clear-cache(清除文档搜索缓存)。脚本运行在前台,不应后台执行。脚本示例:python plugins/openai-ecosystem/skills/codex-cli-docs/scripts/management/refresh_index.py;python plugins/openai-ecosystem/skills/codex-cli-docs/scripts/core/scrape_docs.py;查找文档可用 find_docs.py resolve <doc_id>、search 关键词、query "自然语言"、category、tag 等子命令,支持 --limit、--no-limit、--min-score、--fast、--json、--verbose 选项。索引操作需使用 manage_index.py(count/list/get/verify),不要用 read_file 读取 index.yaml。外部工具可通过 codex_docs_api.py 的公开 API 调用搜索与解析。

适用场景:需要抓取或离线查阅 Codex CLI 文档、按自然语言或关键词检索文档、在引用中避免链接失效、按需提取文档子章节以节省上下文。

限制与要求:需 Python 3.11+,依赖 pyyaml、requests、beautifulsoup4、markdownify、filelock,可选 yake。PowerShell 中禁止使用 cd 与 && 组合以防路径重复,应使用绝对路径或分开命令;Windows 上建议用 PowerShell 或在 Git Bash 前加 MSYS_NO_PATHCONV=1。抓取时 404 属预期情况,脚本会优雅处理并继续。配置项可通过环境变量 CODEX_DOCS_<SECTION>_<KEY> 覆盖。首次发布状态为等待 llms.txt 源配置,具体源清单暂未提供。