ai-infra-documenter is a tool designed to automatically generate documentation for AWS infrastructure code. By leveraging large language models (LLMs) via OpenAI's API, it parses Terraform and AWS Cloud Development Kit (CDK) files and produces comprehensive documentation and architectural diagrams.
- Automatic Documentation: Extracts infrastructure code and generates README files and diagrams.
- AI-powered Analysis: Utilizes advanced LLMs to understand and describe complex infrastructure setups.
- Multi-format Support: Reads Terraform (.tf) and CDK (.ts, .py) files for flexible integration into various workflows.
generate_docs.py: Main script to process infrastructure code and generate documentation.prompts.py: Contains functions for generating prompts used by the LLM..env.template: Template for defining API keys and configuration settings.pyproject.toml: Defines the project setup and dependencies.README.md: Project overview and instructions.
- Python 3.11 or above
- AWS CLI (>=2.0)
- OpenAI API key
- Access to GitHub API for repository processing
- Terraform/CDK files to be documented
- Clone the repository:
git clone https://github.com/parraletz/infra-documenter-ai.git
cd infra-documenter-ai- Install dependencies using Poetry:
poetry install- Configure environment variables by copying
.env.templateto.envand filling in necessary values:
OPENAI_API_KEY="your-openai-api-key"
LANGCHAIN_API_KEY="your-langchain-api-key"Run the script to process a repository and generate documentation:
python generate_docs.pyThis command will generate documentation for the specified directory of infrastructure as code files, outputting results in an output directory organized by folder.
This project is licensed under the MIT License.
Contributions are welcome! Please feel free to submit a Pull Request or issue for any improvements or bug fixes.