SuperAPI AI 工具集

indexion-plan-reconcile

写作与研究

查看项目

更新于 10-16 06:43

技能介绍

用途:检测实现与文档之间的漂移,通过比较文件时间戳和内容关联来找出可能过时的文档。适用于用户怀疑文档已过时、发布前核对文档与代码、大型重构后查找需更新的文档。

主要能力:使用倒排索引加速匹配,在原生目标上可选基于 fork 的并行处理。可输出 JSON、Markdown 或 GitHub Issue 格式;支持作用于指定范围、文档路径和文档类型;可自定义漂移阈值、仅用文件 mtime、限制输出数量、使用配置文件,并支持逻辑审查队列。

使用方式:基本命令为 indexion plan reconcile <path>。常用示例包括 --format=md 生成 Markdown 报告,--scope=package-docs 或 --scope=tree-docs 限定范围,--doc='docs/**/*.md' 限定文档路径,--doc-spec=markdown 限定文档类型,--threshold-seconds=3600 调整阈值,--mtime-only 跳过 git 时间戳,--max-candidates=50 限制输出,--config=.indexion.toml 指定配置,--format=github-issue 输出 Issue 格式。

工作流:先运行 indexion plan reconcile . 扫描漂移,审查候选项(每项显示源文件及其相关文档),更新过时文档,再次运行验证漂移是否解决。

选项默认值:--format 默认 json,--threshold-seconds 默认 60,--max-candidates 默认 200,--logical-review 默认 queue,--index-dir 默认 .indexion/cache/reconcile,其余如 scope、specs、config、doc、doc-spec 等无默认值。

限制:资料未提供安装方式、依赖要求、支持平台与价格信息。