SuperAPI AI 工具集

setup

写作与研究

查看项目

更新于 10-19 19:24

技能介绍

用途

setup 是 doc-sentinel 的配置子命令(doc-sentinel:setup),通过交互式向导为项目创建 .doc-sentinel.json,用于后续文档漂移检测。该向导会探测项目布局、发现文档文件,并让用户确认配置值后写入项目根目录。

主要能力与使用方式

向导按阶段执行:

  1. 探测项目结构:运行 ls -la,检查 docs/ 目录是否存在,检查 AGENTS.md、ARCHITECTURE.md、CLAUDE.md、README.md、CHANGELOG.md 等顶层文档,读取已有 .doc-sentinel.json,并检查 .doc-sync.json 与 .inkwell.json 等配套插件配置。
  2. 发现文档:查找排除 node_modules 与 .git 的 Markdown 文件,并列出 src/、lib/、app/、packages/ 等源码目录。
  3. 交互配置:展示检测值并请求确认。

配置字段包括:version(默认 1)、docs_root(默认 "docs")、watch_files(默认 ["AGENTS.md", "ARCHITECTURE.md", "README.md"])、ignore_sources(默认 [".test.", ".spec.", "tests/**", "*.d.ts"])、ignore_docs(默认空)以及 severity(按文档类别设定漂移严重度)。

严重度分级:high 表示立即标记,medium 表示会话结束时标记,low 表示仅纳入扫描报告。默认值为 architecture → high、agents_md → high、api_reference → medium、changelog → low、readme → medium。

若存在 doc-sync 或 inkwell 配置,向导会说明 doc-sentinel 与它们互补:后者负责写文档,sentinel 负责发现文档与实际不符的漂移,且使用独立队列文件,无冲突。

最后写入 .doc-sentinel.json 到项目根目录,建议将临时的 .doc-sentinel-drift.json 加入 .gitignore(配置文件本身应提交),并打印配置摘要,提示钩子会在每次提交时检测漂移,可运行 /doc-sentinel:scan 生成基线报告。

适用场景

适用于使用 doc-sentinel 进行文档漂移检测的项目,在首次接入或调整监控范围时初始化配置;也适用于已使用 doc-sync 或 inkwell 的项目补充漂移检测能力。

限制

资料未说明支持的操作系统、运行时依赖、安装命令或具体调用方式;资料未提供收费、价格或效果数据。