生成器

Name: 生成器
Author: context-hub

作者：context-hub261 星标更新：2025-10-09

安装使用来源：spider==github.com

项目介绍

CTX: 专业AI开发工具，适用于每位开发者

几分钟内创建LLM就绪的上下文

早上好，LLM

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

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

  - description: 另一个文档
    outputPath: another-document.md
    sources:
      - type: file
        sourcePaths:
          - src/SomeModule

此配置将从 src/Auth 目录收集所有PHP文件以及 src/Models 目录中任何包含“User”的PHP文件到单个上下文文件 .context/auth.md 中。然后可以将此文件粘贴到聊天会话中或通过内置的 MCP服务器提供。

为什么选择CTX？

目前的AI编码工具会自动扫描你的整个代码库，这会产生几个问题：

安全风险：你的敏感文件（环境变量、令牌、私有代码）会被上传到云服务
上下文稀释：AI被无关代码淹没，降低输出质量
无控制：你无法影响AI在生成响应时考虑的内容
昂贵：高级工具根据它们扫描的内容收费，而不是你实际需要的内容

CTX方法

你比任何AI都更了解你的代码。CTX让你掌控一切：

✅ 精确定义要分享的上下文——不多也不少
✅ 保持敏感数据本地化——适用于本地LLM或精心策划的云上下文
✅ 生成可重复使用的共享上下文——提交配置到你的仓库
✅ 改善代码架构——为AI上下文窗口设计自然导致更好的模块化代码
✅ 适用于任何LLM——Claude、ChatGPT、本地模型或未来工具

快速开始

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

Linux / Wsl

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

Windows

powershell -c "& ([ScriptBlock]::Create((irm 'https://raw.githubusercontent.com/context-hub/generator/main/download-latest.ps1'))) -AddToPath"

这将在你的系统上安装 ctx 命令（通常位于 /usr/local/bin）。

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

五分钟设置

初始化你的项目：

cd your-project

ctx init

这将生成一个带有基本配置的 context.yaml 文件，并显示你的项目结构，帮助你理解可能有用的上下文。

查看命令参考以获取所有可用命令和选项。

创建你的第一个上下文：

ctx generate

使用你喜欢的AI：

将生成的markdown文件复制到你的AI聊天中
或者使用内置的MCP服务器与你的MCP客户端（如Claude Desktop、Cursor、Continue、Windsurf）
或者使用开源模型进行本地处理

实际用例

🚀 新成员入职

# 快速项目概述，供新开发者使用
documents:
  - description: "项目架构概述"
    outputPath: "docs/architecture.md"
    sources:
      - type: tree
        sourcePaths: [ "src" ]
        maxDepth: 2
      - type: file
        description: "核心接口和主要类"
        sourcePaths: [ "src" ]
        filePattern: "*Interface.php"

📝 特性开发

# 开发新特性的上下文
documents:
  - description: "用户认证系统"
    outputPath: "contexts/auth-context.md"
    sources:
      - type: file
        sourcePaths: [ "src/Auth", "src/Models" ]
        filePattern: "*.php"
      - type: git_diff
        description: "最近的认证更改"
        commit: "last-week"

📚 文档生成

# 生成API文档
documents:
  - description: "API文档"
    outputPath: "docs/api.md"
    sources:
      - type: file
        sourcePaths: [ "src/Controllers" ]
        modifiers: [ "php-signature" ]
        contains: [ "@Route", "@Api" ]

关键特性

🎯 精准上下文控制

定义要包含哪些文件、目录或代码模式
根据内容、文件模式、日期范围或大小过滤
应用修饰符以提取仅相关部分（例如，函数签名）

🔒 设计安全

本地优先：本地生成上下文，选择要分享的内容
无自动上传：不像那些扫描一切的工具，你控制发送什么
适用于本地模型：完全离线使用Ollama、LM Studio等

🔄 版本控制集成

上下文配置是项目的一部分
团队成员获得相同的上下文
随着代码库的变化而发展上下文
包含git diff以显示最近的更改

🛠 开发者体验

快速：几秒钟生成上下文，无需手动复制
灵活：适用于任何AI工具或本地模型
可共享：提交配置，与团队共享
可扩展：插件系统用于自定义源和修饰符

架构

CTX遵循简单的流水线：

配置 → 源 → 过滤器 → 修饰符 → 输出

源：从哪里获取内容（文件、GitHub、git diff、URL等）
过滤器：包括/排除什么（模式、内容、日期、大小）
修饰符：如何转换内容（提取签名、移除注释）
输出：准备供AI消费的结构化markdown

连接到MCP客户端（可选）

为了更无缝的体验，你可以使用内置的MCP服务器将CTX连接到任何兼容MCP的客户端。

# 交互式设置：检测操作系统并为你的客户端安装配置
ctx mcp:config

此命令：

🔍 自动检测你的操作系统（Windows、Linux、macOS、WSL）
🧩 让你选择你的MCP客户端（例如，Claude Desktop、Cursor、Continue、Windsurf）
🎯 生成并可选安装适合你环境的正确配置
📋 提供复制粘贴即可使用的JSON，如果你喜欢手动设置
🧭 包括设置说明和故障排除技巧

全局注册表模式（推荐用于多个项目/客户端）：

{
  "mcpServers": {
    "ctx": {
      "command": "ctx",
      "args": [
        "server"
      ]
    }
  }
}

如果你喜欢手动设置，请将你的MCP客户端指向CTX服务器：

{
  "mcpServers": {
    "ctx": {
      "command": "ctx",
      "args": [
        "server",
        "-c",
        "/path/to/project"
      ]
    }
  }
}

注意：阅读更多关于 MCP服务器的详细设置说明和故障排除。具体配置文件位置因客户端而异。

现在你可以使用你喜欢的MCP客户端（包括Claude Desktop）询问有关你的代码库的问题，而无需手动上传上下文文件。

自定义工具

定义可以通过MCP界面执行的项目特定命令：

tools:
  - id: run-tests
    description: "运行项目测试并生成覆盖率报告"
    type: run
    commands:
      - cmd: npm
        args: [ "test", "--coverage" ]

完整文档

访问以下链接查看完整文档，包括所有可用功能和配置选项：

https://docs.ctxllm.com

加入我们的社区

加入数百位使用CTX进行专业AI辅助编程的开发者：

你在我们的Discord中能找到：

💡 分享和发现上下文配置
🛠️ 获取设置和高级用法的帮助
🚀 展示你的AI开发流程
🤝 与志同道合的开发者交流
📢 最先知道新发布和功能

许可证

本项目采用MIT许可证。