Terraform Ingest

🚀 Terraform Ingest

Terraform RAGインジェストエンジンです。TerraformのGitリポジトリソースのYAMLファイルを受け取り、既存の資格情報を使用してローカルにダウンロードします。指定したブランチまたはタグ付きリリースについて、目的、入力、出力、およびプロバイダのJSONサマリーを作成し、類似性検索のためにベクトルデータベースに埋め込みます。使いやすいCLI、API、またはMCPサーバーを備えています。

✨ 主な機能

• 📥 複数リポジトリのインジェスト：単一のYAML設定から複数のTerraformリポジトリを処理します。
• 🔄 自動インポート：GitHub組織やGitLabグループからリポジトリをインポートします（Bitbucketのサポートは近日追加予定）。
• 🔍 包括的な分析：変数、出力、プロバイダ、モジュール、および説明を抽出します。
• 🏷️ ブランチとタグのサポート：任意のブランチとGitタグを分析します。
• 🔌 デュアルインターフェース：CLIツール（Click）またはREST APIサービス（FastAPI）として使用できます。
• 🤖 MCP統合：STDIO、SSE、またはStreamable-httpを介してAIエージェントがインジェストされたモジュールにアクセスできるMCPサービスです。
• 📊 JSON出力：RAGインジェストに適した構造化されたJSONサマリーを生成します。
• 🔐 資格情報サポート：プライベートリポジトリに既存のGit資格情報を使用します。
• 🧠 ベクトルデータベース埋め込み：ChromaDB、OpenAI、Claude、またはsentence-transformersを使用した意味検索が可能です。

詳細なドキュメントはこちらを参照してください。

また、これをMCPサーバーとして使用する概要（およびいくつかの例）については、こちらを確認してください。

カスタムモジュールの長いリストがあるサンプルプロジェクトリポジトリはこちらにあります。

📦 インストール

このアプリケーションは、uvまたはDockerを使用してローカルで実行できます。

⚠️ 重要提示

一部の大きな依存関係を遅延ロードするにはuvが必要です。

uv tool install terraform-ingest

# 設定ファイルを作成
uv run terraform-ingest init config.yaml

# またはGitHub組織からリポジトリをインポート
uv run terraform-ingest import github --org terraform-aws-modules --terraform-only

# またはGitLabグループからリポジトリをインポート
uv run terraform-ingest import gitlab --group mygroup --recursive --terraform-only

# config.yamlファイルを更新してTerraformモジュール情報とMCP設定を含め、最初のインジェストを実行
uv run terraform-ingest ingest config.yaml

# クイックなCLI検索を実行してテスト
uv run terraform-ingest search "vpc module for aws"

## Docker
docker pull ghcr.io/zloeber/terraform-ingest:latest

# 永続化のためにボリュームをマウントし、ローカルのconfig.yamlファイルからモジュールをインジェスト
docker run -v $(pwd)/repos:/app/repos -v $(pwd)/output:/app/output -v $(pwd)/config.yaml:/app/config.yaml ghcr.io/zloeber/terraform-ingest:latest ingest /app/config.yaml

# MCPサーバーとして実行
docker run -v $(pwd)/repos:/app/repos -v $(pwd)/output:/app/output -v $(pwd)/config.yaml:/app/config.yaml -p 8000:8000 ghcr.io/zloeber/terraform-ingest:latest mcp -c /app/config.yaml

# モジュールを検索して最初の結果を取得し、すべての詳細を表示
terraform-ingest search "vpc module for aws" -l 1 -j | jq -r '.results[0].id' | xargs -I {} terraform-ingest index get {}

📄 ライセンス

MITライセンス

🤝 コントリビューション

コントリビューションは大歓迎です！プルリクエストを送信してください。