kit 🛠️ 代码智能工具包

kit 是一个生产就绪的工具包，用于代码库映射、符号提取、代码搜索，以及构建由大语言模型驱动的开发者工具、代理和工作流。

使用 kit 可以构建诸如代码审查工具、代码生成器，甚至 IDE 等工具，并为其注入恰当的代码上下文。你可以直接从 Python 中使用 kit，也可以通过 MCP + 函数调用、REST 或 CLI 来操作。

请查阅 完整文档，了解详细的使用方法、高级功能及实用示例。同时，也别忘了查看 kit 的 本地开发 MCP 服务器文档。

快速安装

从 PyPI 安装

uv pip install cased-kit

# 若需启用机器学习功能以进行高级分析和向量搜索
uv pip install 'cased-kit[all]'

使用 uv 全局安装（最便于 CLI 使用）

若希望全局使用 kit CLI 而不影响系统 Python 环境，可使用 uv tool install 命令。这将为 kit 创建一个隔离环境，同时使 CLI 在任何位置均可调用：

# 全局安装基础版 kit CLI
uv tool install cased-kit

# 安装完整版（包括 MCP 服务器及所有功能）
uv tool install cased-kit[all]

安装完成后，kit 和 kit-dev-mcp 命令将在全局可用。如需管理你的 uv 工具安装：

# 列出已安装的工具
uv tool list

# 如有需要，卸载
uv tool uninstall cased-kit

Claude Code 插件

你可以在 Claude Code 中直接使用 kit，只需安装官方插件即可：

/plugin marketplace add cased/claude-code-plugins
/plugin install kit-cli

该插件会赋予 Claude 对 kit 代码库分析工具的自主访问权限。当你提出类似以下问题时，Claude 将自动调用 kit：

• “这个代码库中的认证机制是如何工作的？”
• “查找 UserModel 类的所有使用点”
• “该项目有哪些依赖项？”
• “展示 src 目录的文件结构”

更多详情请参阅 Claude Code 集成指南。

工具包使用

基础 Python API

from kit import Repository

# 加载本地代码库
repo = Repository("/path/to/your/local/codebase")

# 加载远程公开 GitHub 仓库
repo = Repository("https://github.com/owner/repo")

# 加载私有 GitHub 仓库（若设置了 KIT_GITHUB_TOKEN，则会自动使用）
repo = Repository("https://github.com/owner/private-repo")

# 或者显式指定
repo = Repository("https://github.com/owner/private-repo", github_token="ghp_...")

# 指定特定的提交、标签或分支
# repo = Repository("https://github.com/owner/repo", ref="v1.2.3")

# 处理多代码库（微服务、单体仓库、团队项目）
from kit import MultiRepo
repos = MultiRepo(["~/code/frontend", "~/code/backend", "~/code/shared"])
repos.search("handleAuth")  # 在所有代码库中搜索

# 探索代码库
print(repo.get_file_tree())
# 输出：[{"path": "src/main.py", "is_dir": False, ...}, ...]

print(repo.extract_symbols('src/main.py'))
# 输出：[{"name": "main", "type": "function", "file": "src/main.py", ...}, ...]

# 访问 Git 元数据
print(f"当前 SHA：{repo.current_sha}")
print(f"分支：{repo.current_branch}")

# 读取单个文件
main_py = repo.get_file_content("src/main.py")

# 一次性读取多个文件
contents = repo.get_file_content([
    "src/main.py",
    "src/utils/helper.py",
    "tests/test_main.py",
])
print(contents["src/utils/helper.py"])

命令行界面

kit 提供了功能全面的命令行工具，用于代码库分析和代码探索。

代码库分析：

# 获取代码库文件结构
kit file-tree /path/to/repo

# 提取符号（函数、类等）
kit symbols /path/to/repo --format table

# 搜索代码模式
kit search /path/to/repo "def main" --pattern "*.py"

# 查找符号的使用位置
kit usages /path/to/repo "MyClass"

# 导出数据供外部工具使用
kit export /path/to/repo symbols symbols.json

PR 审查：

# 初始化配置
kit review --init-config

# 审查 GitHub PR
kit review --dry-run https://github.com/owner/repo/pull/123
kit review https://github.com/owner/repo/pull/123

# 审查本地 Git 差异（无需 PR！）
kit review main..feature  # 比较两个分支
kit review HEAD~3..HEAD   # 审查最近的 3 次提交
kit review --staged       # 审查暂存区的更改

PR 摘要：

# 生成 PR 摘要以便快速分类
kit summarize https://github.com/owner/repo/pull/123
kit summarize --update-pr-body https://github.com/owner/repo/pull/123

提交信息：

# 根据暂存区的更改生成智能提交信息
git add .  # 先暂存更改
kit commit  # 分析并提交，附带 AI 生成的提交信息

包搜索（需提供 Chroma API 密钥）：

kit package-search-grep numpy "def.*fft" --max-results 10  # 传统 grep 样式的输出
kit package-search-grep numpy "def.*fft" --json           # 结构化 JSON 输出
kit package-search-hybrid django "authentication middleware"
kit package-search-read requests "requests/models.py"

更多详细用法，请参阅 CLI 文档。

工具包核心功能

kit 帮助您的应用和智能体理解和交互代码库，提供构建自定义 AI 驱动开发工具的组件。

• 探索代码结构：

  • 使用 repo.get_file_tree() 获取高层次视图，列出所有文件和目录。您还可以指定子目录以进行更有限的扫描。
  • 通过 repo.extract_symbols() 深入挖掘函数、类和其他代码结构，可针对整个仓库或单个文件执行。
  • 使用 repo.extract_symbols_incremental() 进行快速且具备缓存感知的符号提取——尤其适用于处理代码库的小规模变更。

• 精准定位信息：

  • 使用 repo.search_text() 在整个代码库中执行快速正则表达式搜索（在可用时自动调用 ripgrep 以实现 10 倍加速）。
  • 通过 repo.find_symbol_usages() 跟踪特定符号（如函数或类）的使用情况。
  • 利用基于 AST 的模式匹配按代码结构查找内容（例如异步函数、try 块、类继承等）。

• 为 LLM 和分析准备代码：

  • 使用 repo.chunk_file_by_lines() 或 repo.chunk_file_by_symbols() 将大文件拆分为适合 LLM 上下文窗口的片段。
  • 根据文件中的某一行号获取函数或类的完整定义，使用 repo.extract_context_around_line()。

• 生成代码摘要：

  • 利用 LLM 为文件、函数或类创建自然语言摘要，使用 Summarizer（例如 summarizer.summarize_file()、summarizer.summarize_function()）。
  • 使用 DocstringIndexer 构建这些 AI 生成文档字符串的可搜索索引，并通过 SummarySearcher 查询以实现智能化代码发现。

• 分析代码依赖关系：

  • 使用 repo.get_dependency_analyzer() 绘制模块之间的导入关系图，帮助理解代码库结构。
  • 通过 analyzer.generate_dependency_report() 和 analyzer.generate_llm_context() 生成依赖报告及适合 LLM 的上下文信息。

• 搜索软件包源码（通过 Chroma）：

  • 使用 ChromaPackageSearch 按正则模式和语义查询搜索热门软件包的源码。
  • 可访问 numpy、django、fastapi、pandas 等软件包的源代码。
  • 集成到 kit-dev MCP 中，便于在 AI 助手内无缝探索软件包。

• 仓库版本控制与历史分析：

  • 使用 ref 参数在特定提交、标签或分支上分析仓库。
  • 对比代码随时间的变化，处理差异，确保分析结果的可重复性。
  • 通过 repo.current_sha、repo.current_branch 等方法访问 Git 元数据，包括当前 SHA、分支和远程 URL。

• 多仓库分析：

  • 使用 MultiRepo 同时分析多个仓库，适用于微服务、单体仓库或团队项目。
  • 实现跨所有仓库的统一搜索、符号查找和依赖审计。
  • 提供 CLI 支持：kit multi search、kit multi deps、kit multi summary。

MCP 服务器（kit-dev MCP）

kit 包含一个增强版的 MCP（模型上下文协议），即 kit-dev，专为个人本地开发工作设计。它不仅包含 kit 的生产级代码智能和上下文构建能力，还增加了多源文档检索和软件包搜索功能。

环境变量： OPENAI_API_KEY、OPENAI_BASE_URL（用于代理或自定义端点）、ANTHROPIC_API_KEY

→ 完整 kit-dev MCP 文档

kit 驱动的功能与实用工具

作为该库的示例展示，同时也是独立产品，kit 自带 MIT 许可的基于 CLI 的拉取请求评审和摘要生成功能。

PR 评审

该拉取请求评审工具的表现可媲美一些优秀的闭源付费方案，但成本仅为后者的一小部分，且仅需支付云端模型的 token 费用。在 Cased，我们广泛使用 kit 结合 Sonnet 4 和 gpt4.1 等模型，只需支付 token 费用即可。

kit review --init-config
kit review https://github.com/owner/repo/pull/123

→ 完整 PR 评审文档

PR 摘要

为了快速对拉取请求进行分类和理解，kit 提供了一项快速且经济高效的 PR 摘要生成功能。非常适合团队在决定是否进行详细评审之前，快速了解 PR 的内容。

kit summarize https://github.com/owner/repo/pull/123
kit summarize --update-pr-body https://github.com/owner/repo/pull/123

主要特点：

• 成本仅为完整评审的 5–10 分之一（约 $0.005–0.02，而完整评审约为 $0.01–0.05+）。
• 快速分类：快速概览更改内容、影响及关键修改。

提交信息

利用相同的仓库智能，从暂存的更改中生成智能提交信息：

git add .       # 暂存更改
kit commit      # 分析并提交，附带 AI 生成的提交信息

文档

完整文档 - 详细用法、高级功能和实用示例。同时提供完整的 REST 文档。

kit-dev MCP 文档 - 增强版 MCP 服务器的完整指南。

变更日志 - 跟踪 kit 各版本的所有变更和改进。

许可证

MIT 许可证

贡献

• 本地开发： 请参阅我们的 运行测试 指南，开始本地开发。
• 项目方向： 请查看我们的 路线图 以了解未来的计划和重点方向。

如需贡献，请 fork 本仓库，做出更改后提交拉取请求。

Kit 代码智能工具包快速上手指南

kit 是一个生产级的代码库映射、符号提取和代码搜索工具包，专为构建基于大语言模型（LLM）的开发者工具、Agent 和工作流设计。它可以帮助您轻松构建代码审查器、代码生成器甚至增强型 IDE。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows。
• Python 版本：建议 Python 3.9 及以上版本。
• 前置依赖：
  • 推荐使用 uv 进行包管理和工具安装（速度极快且隔离性好）。
  • 若需使用 Git 相关功能（如 PR 审查、差异分析），请确保系统已安装 git。
  • （可选）若需高级分析和向量搜索功能，安装时需包含额外依赖。
• 网络提示：由于 kit 托管于 GitHub 和 PyPI，国内用户若遇到下载缓慢问题，可配置国内镜像源（如清华源或阿里源）加速 uv pip 安装过程。

安装步骤

方式一：使用 uv 全局安装（推荐，最适合 CLI 使用）

此方式将 kit 安装在独立的隔离环境中，并全局可用，不会污染系统 Python。

# 安装基础版 CLI
uv tool install cased-kit

# 安装完整版（包含 MCP 服务器、机器学习特性及向量搜索支持）
uv tool install 'cased-kit[all]'

安装完成后，kit 和 kit-dev-mcp 命令即可在终端任意位置使用。

方式二：通过 PyPI 安装到当前项目

如果您希望在特定的 Python 虚拟环境中使用 kit 的 Python API：

# 使用 uv 安装基础版
uv pip install cased-kit

# 使用 uv 安装完整版（含高级分析功能）
uv pip install 'cased-kit[all]'

# 若使用 pip 且需国内加速，可指定镜像源：
# pip install cased-kit -i https://pypi.tuna.tsinghua.edu.cn/simple

方式三：集成到 Claude Code

若您是 Claude Code 用户，可通过插件直接调用：

/plugin marketplace add cased/claude-code-plugins
/plugin install kit-cli

基本使用

1. Python API 快速开始

最基础的用法是加载一个代码库并探索其结构或提取符号。

from kit import Repository

# 加载本地代码库
repo = Repository("/path/to/your/local/codebase")

# 或者加载远程公共 GitHub 仓库
# repo = Repository("https://github.com/owner/repo")

# 获取文件树结构
file_tree = repo.get_file_tree()
print(file_tree)

# 提取特定文件中的符号（函数、类等）
symbols = repo.extract_symbols('src/main.py')
print(symbols)

# 读取文件内容
content = repo.get_file_content("src/main.py")
print(content)

# 跨多个仓库搜索（适用于微服务或单体仓库）
from kit import MultiRepo
repos = MultiRepo(["~/code/frontend", "~/code/backend"])
results = repos.search("handleAuth")  # 在所有仓库中搜索 "handleAuth"
print(results)

2. 命令行界面 (CLI) 核心功能

安装后，您可以直接在终端使用强大的 kit 命令。

查看代码结构与符号：

# 获取仓库文件树
kit file-tree /path/to/repo

# 以表格形式提取所有符号（函数、类等）
kit symbols /path/to/repo --format table

# 搜索代码模式（底层自动调用 ripgrep 加速）
kit search /path/to/repo "def main" --pattern "*.py"

智能代码审查与总结：

# 初始化配置文件
kit review --init-config

# 审查 GitHub Pull Request
kit review https://github.com/owner/repo/pull/123

# 审查本地 Git 分支差异（无需创建 PR）
kit review main..feature

# 生成 PR 摘要用于快速分类
kit summarize https://github.com/owner/repo/pull/123

辅助开发工作流：

# 基于暂存区变更生成智能 Commit 消息
git add .
kit commit

3. 进阶：多仓库与上下文构建

kit 的核心优势在于为 LLM 提供精准的代码上下文。您可以利用它将大文件切片，或构建依赖关系图：

# 将大文件按行切片，适配 LLM 上下文窗口
chunks = repo.chunk_file_by_lines("src/large_module.py", max_lines=50)

# 获取某行代码周围的完整上下文（包含类定义等）
context = repo.extract_context_around_line("src/main.py", line_number=42)

# 分析模块间的依赖关系
analyzer = repo.get_dependency_analyzer()
report = analyzer.generate_dependency_report()

更多高级功能（如 MCP 服务器配置、自定义 Agent 构建）请参阅 官方文档。