mcpField
G
github-kb

github-kb

github.com/lecion开发265 次安装39 周前更新
代码仓库

关于 github-kb

这是一项用于探索 GitHub 仓库并将发现整理到本地知识库的 Claude Code 技能。它先检查索引，再支持克隆和代码分析，并在探索后更新索引。

主要功能

  1. 01优先查询仓库索引
  2. 02将仓库克隆到指定根目录
  3. 03借助分析工具探索代码
  4. 04按类别整理项目
  5. 05更新 CLAUDE.md 索引

适用场景

  1. 01确认仓库是否已有记录
  2. 02探索并分析新仓库
  3. 03维护条理清晰的本地仓库目录

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/lecion/github-kb --skill github-kb

安装后在 Claude Code 中输入/github-kb确认已加载。

附带文件README.md

详细介绍

GitHub 知识库浏览器

安装

通过 Claude Code 插件市场添加：

/plugin marketplace add lecion/github-kb

配置

设置 GITHUB_KB_ROOT 环境变量以自定义工作目录。

工作目录

路径根据 GITHUB_KB_ROOT 环境变量动态确定（默认值：~/github-kb/）。

知识库管理

CLAUDE.md 位置

知识库索引位于 {GITHUB_KB_ROOT}/CLAUDE.md。此文件为所有已探索的仓库建立索引。

CLAUDE.md 格式
# Claude Code 知识库

本目录包含 X 个 GitHub 项目，涵盖...领域描述

---

## Category Name

### [project-name](/project-name)
Brief description of the project
更新 CLAUDE.md

克隆或探索新仓库时，请更新 CLAUDE.md 以保持一致：

  • 在合适的类别下添加项目
  • 包含项目名称（链接至其目录）和简短描述
  • 更新标题中的项目数量

工作流

1. 查询知识库（第一步）

用户询问某个仓库时：

  1. 阅读 {GITHUB_KB_ROOT}/CLAUDE.md，检查项目是否存在
  2. 如果找到，使用 Read、Glob 和 Grep 工具探索现有目录
  3. 如果未找到，则继续克隆
2. 克隆新仓库

用户想要探索新仓库或仓库不存在时：

cd {GITHUB_KB_ROOT}
git clone <repo-url>
  • 根据仓库的可访问性使用 HTTPS 或 SSH
  • 默认克隆目录始终为 {GITHUB_KB_ROOT}
3. 探索与分析

克隆后或处理现有仓库时：

  • 使用带 Explore Agent 的 Task 工具进行全面的代码分析
  • 使用 Glob/Read/Grep 针对性地检查架构和探索相关内容
  • 聚焦于实现细节、技术决策和关键文件
4. 维护知识库

成功探索后：

  • 使用新项目条目更新 CLAUDE.md
  • 添加准确的类别和描述
  • 确保链接和格式正确

CLAUDE.md 的类别

用于整理项目的常见类别：

  • Web 框架 - 前端/后端框架
  • DevOps 工具 - CI/CD、部署、基础设施
  • 机器学习 - ML 库、模型、工具
  • 移动开发 - iOS、Android、跨平台
  • 实用工具 - 命令行工具、效率工具
  • 数据库 - 数据库客户端、ORM
  • API 与服务 - API 客户端、SDK
  • 其他 - 不适合其他类别的项目

环境变量

变量描述默认值
GITHUB_KB_ROOT克隆仓库的根目录~/github-kb/

示例

# Clone a new repository
cd $GITHUB_KB_ROOT
git clone https://github.com/example/repo.git

# Explore an existing repository
Task tool -> Explore agent -> analyze repo structure

# Update knowledge base
Edit CLAUDE.md -> add new project entry

向后兼容性

现有用户无需更改任何配置。默认路径保持向后兼容。

评论

支持 Markdown