SuperAPI AI 工具集

sc-index

编程与开发

查看项目

更新于 10-15 22:14

技能介绍

用途:sc-index 用于创建和维护项目文档、索引与知识库,适合在编写项目文档、生成 API 文档、梳理项目结构、创建或更新 README、为代码库构建知识库时使用。

主要能力:分析项目结构并识别关键组件;从代码注释和 README 中提取文档信息;按指定类型生成文档;建立导航结构与交叉引用;输出组织良好的格式化文档。

使用方式:命令为 /sc:index [target] [--type docs|api|structure|readme] [--format md|json|yaml]。参数中 target 为要记录的项目目录或具体组件;--type 指定文档类型(docs、api、structure、readme);--format 指定输出格式(md、json、yaml);--update 用于更新已有文档。执行流程为:分析项目结构并识别关键组件,从代码注释与 README 提取文档,按类型生成文档,创建导航与交叉引用,最后输出格式化文档。

集成:与 Claude Code 集成,使用 Glob 进行系统性文件发现,使用 Grep 提取文档模式,使用 Write 创建结构化文档,并保持与项目约定一致。

限制:资料未提供具体安装步骤、依赖要求、支持平台、收费方式或效果保证,这些信息暂未提供。