用途:把 GitHub 仓库整理成 Markdown 索引,便于 Claude 项目知识检索与语义匹配。本 v2 为旧实现,官方已标记废弃,建议改用 building-github-index;该新实现以单次 tarball 下载并在本地处理文件,取代了此处逐文件调用 api.github.com 的慢速方式,本目录仅保留以兼容旧引用,不再更新。
主要能力:抓取仓库文件树,生成按类别分组的索引表,描述列在前用于相关性匹配,路径列在后作为检索键;可同时索引多个仓库;支持仅抓取文件树、按 glob 包含或排除文件、限制每仓库文件数;可选用 tree-sitter 提取代码符号;描述来源依次为 YAML frontmatter、Markdown 标题、Notebook 首个 Markdown 单元格标题、代码符号、路径词推断。还提供精简脚本 pk_index.py,可缩小输出体积。
使用方式(旧文档命令,原样保留): python scripts/github_index.py owner/repo -o index.md python scripts/github_index.py owner/repo --code-symbols -o index.md python scripts/github_index.py owner/repo1 owner/repo2 -o combined.md python scripts/github_index.py owner/repo --skip-fetch -o skeleton.md python scripts/pk_index.py owner/repo -o repo_pk.md 选项包括 -o/--output、--token(也读 GITHUB_TOKEN 环境变量)、--include-patterns、--exclude-patterns、--max-files(默认 200)、--skip-fetch、--code-symbols。API 访问使用 api.github.com 与 raw.githubusercontent.com;枚举文件可用 curl -sL "https://api.github.com/repos/OWNER/REPO/git/trees/BRANCH?recursive=1"。
适用场景:为 Claude 项目知识构建仓库内容索引,尤其文档型或代码型仓库;多仓库合并索引;需要精简输出时使用。
限制:已废弃,不再更新,建议改用 building-github-index;逐文件请求慢且消耗 GitHub 逐文件速率限制;部分仓库存在占位文件(外部链接、空 README),描述提取可能失败,此时需人工整理;令牌、私有仓库支持等细节本资料未提供。