ctx: 代码库与 LLM 之间缺失的环节。带有 MCP 服务器的上下文即代码 (CaC) 工具。

<p> <a href="https://docs.ctxgithub.com/"><img alt="文档" src="https://img.shields.io/badge/docs-green"></a> <a href="https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json"><img alt="Json schema" src="https://img.shields.io/badge/json_schema-blue"></a> <a href="https://t.me/spiralphp/2504"><img alt="Telegram" src="https://img.shields.io/badge/telegram-blue.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZD0iTTEyIDI0YzYuNjI3IDAgMTItNS4zNzMgMTItMTJTMTguNjI3IDAgMTIgMCAwIDUuMzczIDAgMTJzNS4zNzMgMTIgMTIgMTJaIiBmaWxsPSJ1cmwoI2EpIi8+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik01LjQyNSAxMS44NzFhNzk2LjQxNCA3OTYuNDE0IDAgMCAxIDYuOTk0LTMuMDE4YzMuMzI4LTEuMzg4IDQuMDI3LTEuNjI4IDQuNDc3LTEuNjM4LjEgMCAuMzIuMDIuNDcuMTQuMTIuMS4xNS4yMy4xNy4zMy4wMi4xLjA0LjMxLjAyLjQ3LS4xOCAxLjg5OC0uOTYgNi41MDQtMS4zNiA4LjYyMi0uMTcuOS0uNSAxLjE5OS0uODE5IDEuMjI5LS43LjA2LTEuMjI5LS40Ni0xLjg5OC0uOS0xLjA2LS42ODktMS42NDktMS4xMTktMi42NzgtMS43OTgtMS4xOS0uNzgtLjQyLTEuMjA5LjI2LTEuOTA4LjE4LS4xOCAzLjI0Ny0yLjk3OCAzLjMwNy0zLjIyOC4wMS0uMDMuMDEtLjE1LS4wNi0uMjEtLjA3LS4wNi0uMTctLjA0LS4yNS0uMDItLjExLjAyLTEuNzg4IDEuMTQtNS4wNTYgMy4zNDgtLjQ4LjMzLS45MDkuNDktMS4yOTkuNDgtLjQzLS4wMS0xLjI0OC0uMjQtMS44NjgtLjQ0LS43NS0uMjQtMS4zNDktLjM3LTEuMjk5LS43OS4wMy0uMjIuMzMtLjQ0Ljg5LS42NjlaIiBmaWxsPSIjZmZmIi8+PGRlZnM+PGxpbmVhckdyYWRpZW50IGlkPSJhIiB4MT0iMTEuOTkiIHkxPSIwIiB4Mj0iMTEuOTkiIHkyPSIyMy44MSIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPjxzdG9wIHN0b3AtY29sb3I9IiMyQUFCRUUiLz48c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiMyMjlFRDkiLz48L2xpbmVhckdyYWRpZW50PjwvZGVmcz48L3N2Zz4K"></a> <a href="https://packagist.org/packages/context-hub/generator"><img alt="许可证" src="https://img.shields.io/packagist/l/context-hub/generator"></a> <a href="https://packagist.org/packages/context-hub/generator"><img alt="最新版本" src="https://img.shields.io/packagist/v/context-hub/generator"></a> </p>

ctx 是一个旨在解决与 ChatGPT 或 Claude 等 LLM 聊天时遇到的一个大问题的工具：为它们提供关于您项目的足够上下文。

有一篇关于 Context Generator 的文章发表在 Medium 上，解释了 该项目背后的动机以及它所解决的问题。

无需每次都手动复制或解释您的整个代码库，ctx 会自动从以下内容构建整洁、有组织的上下文文件：

• 代码文件，
• GitHub 仓库，
• Git 提交和差异
• 带有 CSS 选择器的网页（URL），
• 以及纯文本。

它的创建是为了解决一个常见问题：有效地为 ChatGPT、Claude 等 AI 语言模型提供必要的 关于您的代码库的上下文。

为什么你需要它

当您在开发中使用 AI 时，上下文不仅仅是有帮助，而是至关重要。

• 代码重构帮助：需要 AI 协助重构混乱的代码？ ctx 创建包含所有必要代码文件的干净、结构化的文档。

• 多次迭代开发：与 AI 助手一起进行多次迭代需要不断更新 上下文。 ctx 自动化了这个过程。

• 文档生成：通过将源代码与 自定义解释相结合，将您的代码库转换为全面的文档。 使用 AI 根据您的实际 代码生成用户指南、API 参考或开发者文档。

• 无缝 AI 集成：感谢内置的 MCP 支持，您可以连接 Claude AI 直接连接到您的代码库，允许 进行实时、上下文感知的辅助，而无需手动共享上下文。

工作原理

1. 从文件、目录、GitHub 仓库、网页或纯文本收集代码。
2. 通过模式匹配、内容搜索、大小或日期过滤器定位特定文件
3. 应用可选的修饰符（例如，提取没有实现细节的 PHP 签名）
4. 将内容组织成结构良好的 Markdown 文档
5. 保存上下文文件，以便与 LLM 共享
6. 可选择通过 MCP 服务器提供上下文，允许像 Claude 这样的 AI 助手直接访问项目 信息

有了 ctx，您的 AI 对话变得更加智能和轻松。

快速开始

Context Generator 的入门非常简单。 按照以下简单步骤为 LLM 创建您的第一个上下文文件。

1. 安装 Context Generator

使用我们的安装脚本下载并安装该工具：

curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sh

这会将 ctx 命令安装到您的系统（通常在 /usr/local/bin 中）。

想要更多选项？ 请参阅完整的安装指南 以获取其他安装方法。

2. 初始化配置文件

在您的项目目录中创建一个新的配置文件：

ctx init

这将生成一个 context.yaml 文件，其中包含一个基本结构，可帮助您入门。

专业提示： 如果您喜欢 JSON 配置格式，请运行 ctx init --type=json。 查看命令参考 以获取所有可用命令和选项。

3. 描述您的项目结构

编辑生成的 context.yaml 文件以指定要包含的代码或内容。 例如：

documents:
  - description: "用户身份验证系统"
    outputPath: "auth-context.md"
    sources:
      - type: file
        description: "身份验证控制器"
        sourcePaths:
          - src/Auth
        filePattern: "*.php"

      - type: file
        description: "身份验证模型"
        sourcePaths:
          - src/Models
        filePattern: "*User*.php"

此配置将从 src/Auth 目录收集所有 PHP 文件，并从 src/Models 目录收集名称中包含 "User" 的任何 PHP 文件。

需要更高级的配置？

• 了解文档结构和属性
• 探索不同的源类型，例如 GitHub、Git Diff 或 URL
• 应用修饰符来转换您的内容（例如，提取 PHP 签名）
• 了解如何在配置中使用环境变量
• 使用 IDE 集成 进行自动完成和验证

4. 构建上下文

通过运行以下命令生成您的上下文文件：

ctx

该工具将处理您的配置并创建指定的输出文件（在本例中为 auth-context.md）。

提示：使用 -v、-vv 或 -vvv 配置日志记录 以获取详细输出

5. 与 LLM 共享

将生成的上下文文件上传或粘贴到您喜欢的 LLM（例如 ChatGPT 或 Claude）。 现在您可以提出关于您的代码库的特定 问题，LLM 将具有必要的上下文来提供准确的帮助。

示例提示：

我已经与您分享了我的身份验证系统代码。 您能帮我识别用户注册过程中潜在的安全漏洞吗？

后续步骤： 查看使用 Context Generator 进行开发，了解最佳实践 将上下文生成集成到您的 AI 驱动的开发工作流程中。

就这样！ 您现在可以利用 LLM 获得关于您的代码库的适当上下文。

6. 连接到 Claude AI（可选）

为了获得更无缝的体验，您可以使用 MCP 服务器将 Context Generator 直接连接到 Claude AI：

有一个内置的 MCP 服务器，允许您将 Claude AI 直接连接到您的代码库。

将 MCP 客户端指向 Context Generator 服务器：

{
  "mcpServers": {
    "ctx": {
      "command": "ctx server -c /path/to/your/project"
    }
  }
}

注意： 阅读有关 MCP 服务器 的更多信息，以获取详细的设置说明。

现在您可以向 Claude 询问关于您的代码库的问题，而无需手动上传上下文文件！

JSON 模式

为了获得更好的编辑体验，Context Generator 提供了一个 JSON 模式，用于在您的 IDE 中进行自动完成和验证：

# 显示模式 URL
ctx schema

# 将模式下载到当前目录
ctx schema --download

了解更多： 请参阅 IDE 集成，以获取 VSCode、 PhpStorm 和其他编辑器的详细设置说明。

完整文档

有关完整文档，包括所有可用功能和配置选项，请访问：

https://docs.ctxgithub.com

---

许可证

本项目根据 MIT 许可证获得许可。