SuperAPI AI 工具集

docs-sync

智能体与模型

查看项目

更新于 10-15 23:49

技能介绍

docs-sync 用于将文档与代码库中实际的技能、命令和智能体保持一致。当文档中的技能/命令/智能体数量与目录内容不符、新增或删除条目未反映、交叉引用和分类需要重整时使用;若要从代码生成全新 API 参考、README 或 CHANGELOG,应改用 docs-generate。

主要能力:扫描 .claude/skills、.claude/commands、.claude/agents 目录,解析各项元数据(技能 YAML frontmatter 的名称和描述、命令的描述与命名空间、智能体的名称/描述/工具),对比现有文档找出新增(NEW)、陈旧(STALE)条目并核对计数,随后更新技能目录、命令参考、智能体清单及根级 CLAUDE.md 概览等文件,修正计数、添加缺失条目、移除无效引用,并生成同步报告。

使用方式:/docs:sync [OPTIONS],支持 --scope skills|commands|agents 限定范围,--dry-run 预览不改文件,--verbose 输出详细扫描信息。执行流程为发现条目、分析差异、应用更新、报告结果。技能分类可依据名称前缀(如 ux-、git-、python-*)或描述关键词推断,不确定时归入 Uncategorized 供人工复核;命名空间由目录名前缀决定。

建议先运行 --dry-run 检查分类,再应用并单独提交文档变更。遇到缺失文档文件会按模板创建,YAML frontmatter 格式错误会警告并跳过,重复条目保留首个。关于收费、价格、平台支持等信息,资料中暂未提供。