Generator

🚀 CTX 上下文生成器

CTX 上下文生成器是一款实用工具，它能助力开发者将项目代码及相关内容整理成文档，可方便地与大型语言模型（LLM）共享。通过配置文件描述项目结构，它会自动生成适合上传到 ChatGPT 或 Claude 的 .md 格式文件。

🚀 快速开始

📦 安装指南

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

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

此命令会将 ctx 命令安装到系统（通常在 /usr/local/bin 目录下）。

🔧 初始化配置

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

ctx init

这会生成一个基础的 context.yaml 文件，帮助你快速上手。

⚙️ 配置项目结构

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

$schema: 'https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json'

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 文件。

🏗️ 构建上下文

运行以下命令生成上下文文件：

ctx

CTX 将根据你的配置生成指定的输出文件（如示例中的 auth-context.md）。

🌐 与 LLM 共享上下文

将生成的上下文文件上传或粘贴到你喜欢的 LLM 中（例如 ChatGPT 或 Claude）。现在你可以针对代码库提出具体问题，LLM 将具备必要的背景信息来提供准确帮助。

示例提示：

我已经向你分享了我的用户注册系统代码。你能帮我识别用户注册流程中的潜在安全漏洞吗？

📶 可选步骤：连接 Claude AI

通过 CTX 内置的 MCP 服务器直接连接 Claude AI，实现更无缝的体验： 在配置文件中添加以下内容：

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

这样你就可以让 Claude 直接访问你的代码库！

📚 详细文档

查看更多功能和配置选项，请访问： https://docs.ctxgithub.com

📄 许可证

本项目使用 MIT 许可证。