Generator

🚀 CTX コンテキスト生成器

ctx 環境コンテキスト：このCtxツールは、プロジェクトコードと関連コンテンツをドキュメントに整理し、大規模言語モデル（LLM）と共有するのに役立ちます。設定ファイルでプロジェクト構造を記述することで、CTXは自動的に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ライセンスの下で提供されています。