Skip to main content

A terraform multi-repo module AI RAG ingestion engine that accepts a YAML file of terraform git repository sources, downloads them locally using existing credentials, creates JSON summaries of their purpose, inputs, outputs, and providers on the main and git tag branches for ingestion via a RAG pipeline into a vector database.

Project description

terraform-ingest

A terraform multi-repo module AI RAG ingestion engine that accepts a YAML file of terraform git repository sources, downloads them locally using existing credentials, creates JSON summaries of their purpose, inputs, outputs, and providers for branches or tagged releases you specify for ingestion via a RAG pipeline into a vector database. Includes an easy to use cli, API, or MCP server.

Features

  • 📥 Multi-Repository Ingestion: Process multiple Terraform repositories from a single YAML configuration
  • 🔍 Comprehensive Analysis: Extracts variables, outputs, providers, modules, and descriptions
  • 🏷️ Branch & Tag Support: Analyzes both branches and git tags
  • 🔌 Dual Interface: Use as a CLI tool (Click) or as a REST API service (FastAPI)
  • 🤖 MCP Integration: FastMCP service for AI agent access to ingested modules
  • 📊 JSON Output: Generates structured JSON summaries ready for RAG ingestion
  • 🔐 Credential Support: Uses existing git credentials for private repositories
  • 🧠 Vector Database Embeddings: Semantic search with ChromaDB, OpenAI, Claude, or sentence-transformers

Further documentation found here

Or, if you just want the goods on using this as an MCP server along with some examples check this out.

Installation

This application can be run locally as a CLI, API service, or MCP server using uv or docker.

# simple pip install
pip install terraform-ingest

## UV (preferred)
# Create a config
uv run terraform-ingest init config.yaml

# Update your config.yaml file to include your terraform module information and mcp config then preform the initial ingestion
uv run terraform-ingest ingest

# Run a quick cli search to test things out
uv run terraform-ingest search "vpc module for aws"

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terraform_ingest-0.1.4.tar.gz (378.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

terraform_ingest-0.1.4-py3-none-any.whl (52.9 kB view details)

Uploaded Python 3

File details

Details for the file terraform_ingest-0.1.4.tar.gz.

File metadata

  • Download URL: terraform_ingest-0.1.4.tar.gz
  • Upload date:
  • Size: 378.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for terraform_ingest-0.1.4.tar.gz
Algorithm Hash digest
SHA256 b6508822e6c0e19ac26f52664b6fca7ef897e76dc6dfbb82b252757fe59e691b
MD5 9cab89824d124b026a9de04f9c114555
BLAKE2b-256 da152fe41cb852c80cddff1d2bedce9479e79cd1d575c4138ae309d830f9fb88

See more details on using hashes here.

Provenance

The following attestation bundles were made for terraform_ingest-0.1.4.tar.gz:

Publisher: release.yaml on zloeber/terraform-ingest

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file terraform_ingest-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for terraform_ingest-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fb00603a370f1e3f75e927e9fa2576141af098b97ef01790736b8ff3ff20d42c
MD5 a017ea4658f992940d925e8c11fd3fb5
BLAKE2b-256 22bde7d8d497bb963a53941a809ce5be1210755698c4701b78d8765bfe384030

See more details on using hashes here.

Provenance

The following attestation bundles were made for terraform_ingest-0.1.4-py3-none-any.whl:

Publisher: release.yaml on zloeber/terraform-ingest

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page