CTX生成器
CTX 是一种用于解决与 ChatGPT 或 Claude 等大型语言模型聊天时的一个大问题的工具：为它们提供关于您项目的足够背景信息。
服务介绍
ctx: 你的代码库与大语言模型之间的缺失链接。内置MCP服务器的代码即上下文(CaC)工具。
目录
CTX 是一个旨在解决与像ChatGPT或Claude这样的大语言模型聊天时的一个大问题的工具：为它们提供关于你项目的足够上下文。
有一篇关于Context Generator的文章
在Medium上，解释了项目背后的动机及其解决的问题。
当你在开发中使用AI时，上下文不仅是有帮助的——它是至关重要的。
与其每次手动复制或解释整个代码库，不如让ctx自动从以下内容构建整洁、有组织的上下文文件：
- 代码文件，
- GitHub 和 Gitlab 仓库，
- Git 提交和差异
- 带有 CSS 选择器的网页（URL），
- MCP 服务器
- 以及纯文本。
它被创建来解决一个常见的问题：高效地为像 Claude 这样的 AI 语言模型提供关于你的代码库的必要上下文。
工作原理
- 从文件、目录、GitHub 或 Gitlab 仓库、网页或纯文本中收集代码。
- 通过模式匹配、内容搜索、大小或日期过滤器定位特定文件。
- 应用可选修饰符（如提取不带实现细节的 PHP 签名）
- 将内容组织成结构良好的 Markdown 文档
- 保存好可以与 LLMs 共享的上下文文件
- 可选地通过 MCP 服务器提供上下文，使像 Claude 这样的 AI 助手能够直接访问项目信息
快速开始
使用 CTX 开始非常简单。按照以下简单步骤创建您的第一个上下文文件。
1. 安装 CTX
使用我们的安装脚本下载并安装工具：
curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sh
这会将 ctx 命令安装到您的系统中（通常在 /usr/local/bin）。
想要更多选项？ 查看完整的安装指南，了解替代安装方法。
2. 初始化配置文件
在您的项目目录中创建一个新的配置文件：
ctx init
这将生成一个带有基本结构的 context.yaml 文件以帮助您开始。
检查命令参考以获取所有可用的命令和选项。
3. 描述您的项目结构
编辑生成的 context.yaml 文件以指定您要包含哪些代码或内容。
例如：
$schema: 'https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json'
documents:
- description: "User Authentication System"
outputPath: "auth-context.md"
sources:
- type: file
description: "Authentication Controllers"
sourcePaths:
- src/Auth
filePattern: "*.php"
- type: file
description: "Authentication Models"
sourcePaths:
- src/Models
filePattern: "*User*.php"
此配置将从 src/Auth 目录中收集所有 PHP 文件，并从 src/Models 目录中收集任何名称中包含 "User" 的 PHP 文件。
需要更高级的配置？
- 了解文档结构和属性
- 探索不同的源类型，如 GitHub, Git Diff, 或 URL
- 应用修饰符转换您的内容（如提取 PHP 签名）
- 发现如何在配置中使用环境变量
- 使用IDE 集成进行自动完成和验证
4. 构建上下文
通过运行以下命令生成您的上下文文件：
ctx
CTX 将处理您的配置并创建指定的输出文件（在我们的示例中是 auth-context.md）。
提示：使用
-v,-vv, 或-vvv配置日志记录以获得详细的输出
5. 与大语言模型分享
将生成的上下文文件上传或粘贴到你最喜欢的大语言模型（如ChatGPT或Claude）中。现在你可以针对你的代码库提出具体问题，而大语言模型将拥有必要的上下文来提供准确的帮助。
示例提示：
我已经与你分享了我的认证系统代码。你能帮我识别用户注册过程中可能存在的安全漏洞吗？
下一步： 查看开发与上下文生成器，了解如何将上下文生成集成到由AI驱动的开发工作流程中的最佳实践。
就是这样！你现在可以利用带有正确代码库上下文的大语言模型了。
6. 连接到Claude AI（可选）
为了获得更无缝的体验，你可以通过MCP服务器直接将上下文生成器连接到Claude AI：
有一个内置的MCP服务器允许你直接将Claude AI连接到你的代码库。
将MCP客户端指向上下文生成器服务器：
{
"mcpServers": {
"ctx": {
"command": "ctx server -c /path/to/your/project"
}
}
}
注意： 阅读更多关于MCP服务器的内容以获取详细的设置说明。
现在你可以无需手动上传上下文文件就能向Claude询问有关你代码库的问题！
完整文档
完整的文档，包括所有可用功能和配置选项，请访问：
许可证
本项目遵循MIT许可证。
