Generator

🚀 CTX 上下文生成器

CTX 上下文生成器是一款強大的工具，它能幫助用戶將項目代碼及相關內容整理成文檔，方便與大型語言模型（LLM）共享。通過配置文件描述項目結構，該工具可自動生成適合上傳到 ChatGPT 或 Claude 的 .md 格式文件。

🚀 快速開始

安裝 CTX

使用安裝腳本下載並安裝該工具：

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 許可證。