| Name | terraformreviewer JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Generate Terraform READMEs and inline comments using Claude |
| upload_time | 2025-07-25 09:29:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# terraformreviewer: AI-Powered Terraform Documentation and Comment Generator
`terraformreviewer` is a command-line tool that uses Anthropic’s Claude AI to automatically generate production-ready documentation (`README.md`) and add clear, helpful inline comments to your Terraform (`.tf`) files. This makes your infrastructure-as-code projects easier to understand, maintain, and onboard new team members.
---
## Features
- **Automatic README Generation:** Produces a comprehensive, human-readable `README.md` for your Terraform project.
- **Inline Comments:** Adds concise, informative comments to all `.tf` files, explaining resources, blocks, and configuration.
- **Powered by Claude AI:** Leverages Anthropic’s Claude for high-quality, context-aware documentation and code explanations.
---
## Installation
Install the tool directly from PyPI:
```bash
pip install terraformreviewer
```
Or, if you want the latest development version:
```bash
git clone https://github.com/Zayan-ahmed953/Terraform_Reviewer_AI_Tool.git
cd Terraform_AI_Reviewer
pip install -e .
```
---
## Setup
Before using the tool, you must set your Anthropic API key as an environment variable:
```bash
export ANTHROPIC_API_KEY=<your valueapi key>
```
You can obtain an API key from [Anthropic](https://docs.anthropic.com/claude/docs/quickstart-guide).
---
## Usage
Run the tool from your terminal, pointing it to your Terraform project directory:
```bash
terraformreviewer /path/to/your/terraform/project
```
This will:
- Generate a `README.md` describing your infrastructure.
- Add helpful inline comments to all `.tf` files in the project.
**Example:**
```bash
terraformreviewer /home/zayan/Desktop/My-Projects/AI-Generated-sample-terraform/
```
---
## Notes
- If you rerun the tool without changing your Terraform files, it will skip regeneration for efficiency.
- Ensure your API key is valid and you have internet access.
---
## Troubleshooting
- **No .tf files found:** Make sure you provide the path to a directory containing Terraform files.
- **API key error:** Double-check that `ANTHROPIC_API_KEY` is set in your environment.
- **Other errors:** Please open an issue with the error message and steps to reproduce.
Raw data
{
"_id": null,
"home_page": null,
"name": "terraformreviewer",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Your Name <you@example.com>",
"download_url": "https://files.pythonhosted.org/packages/54/ac/8208c5ea359ff5b7c20a71842e76a413c73a77b2580f91d1b6484125e0aa/terraformreviewer-0.1.3.tar.gz",
"platform": null,
"description": "# terraformreviewer: AI-Powered Terraform Documentation and Comment Generator\n\n`terraformreviewer` is a command-line tool that uses Anthropic\u2019s Claude AI to automatically generate production-ready documentation (`README.md`) and add clear, helpful inline comments to your Terraform (`.tf`) files. This makes your infrastructure-as-code projects easier to understand, maintain, and onboard new team members.\n\n---\n\n## Features\n\n- **Automatic README Generation:** Produces a comprehensive, human-readable `README.md` for your Terraform project.\n- **Inline Comments:** Adds concise, informative comments to all `.tf` files, explaining resources, blocks, and configuration.\n- **Powered by Claude AI:** Leverages Anthropic\u2019s Claude for high-quality, context-aware documentation and code explanations.\n\n---\n\n## Installation\n\nInstall the tool directly from PyPI:\n\n```bash\npip install terraformreviewer\n```\n\nOr, if you want the latest development version:\n\n```bash\ngit clone https://github.com/Zayan-ahmed953/Terraform_Reviewer_AI_Tool.git\ncd Terraform_AI_Reviewer\npip install -e .\n```\n\n---\n\n## Setup\n\nBefore using the tool, you must set your Anthropic API key as an environment variable:\n\n```bash\nexport ANTHROPIC_API_KEY=<your valueapi key>\n```\n\nYou can obtain an API key from [Anthropic](https://docs.anthropic.com/claude/docs/quickstart-guide).\n\n---\n\n## Usage\n\nRun the tool from your terminal, pointing it to your Terraform project directory:\n\n```bash\nterraformreviewer /path/to/your/terraform/project\n```\n\nThis will:\n- Generate a `README.md` describing your infrastructure.\n- Add helpful inline comments to all `.tf` files in the project.\n\n**Example:**\n\n```bash\nterraformreviewer /home/zayan/Desktop/My-Projects/AI-Generated-sample-terraform/\n```\n\n---\n\n## Notes\n\n- If you rerun the tool without changing your Terraform files, it will skip regeneration for efficiency.\n- Ensure your API key is valid and you have internet access.\n\n---\n\n## Troubleshooting\n\n- **No .tf files found:** Make sure you provide the path to a directory containing Terraform files.\n- **API key error:** Double-check that `ANTHROPIC_API_KEY` is set in your environment.\n- **Other errors:** Please open an issue with the error message and steps to reproduce.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Generate Terraform READMEs and inline comments using Claude",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6b01400517ab9794c754a4f1a65a29f156322018cc64b91a1ed828201656d0b3",
"md5": "3cdcdebb33482ff3b95d2735557fc340",
"sha256": "8e27bb89f56cf742bbb31a859a66b3602e78bfed3ab8c4f8578149146cebcab4"
},
"downloads": -1,
"filename": "terraformreviewer-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3cdcdebb33482ff3b95d2735557fc340",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4860,
"upload_time": "2025-07-25T09:29:52",
"upload_time_iso_8601": "2025-07-25T09:29:52.936154Z",
"url": "https://files.pythonhosted.org/packages/6b/01/400517ab9794c754a4f1a65a29f156322018cc64b91a1ed828201656d0b3/terraformreviewer-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "54ac8208c5ea359ff5b7c20a71842e76a413c73a77b2580f91d1b6484125e0aa",
"md5": "432b0a4ae56af155f2867ac45ec41d46",
"sha256": "27ca376e161e1f075a5c96c37dc9257199273442209976382f676a3605c77661"
},
"downloads": -1,
"filename": "terraformreviewer-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "432b0a4ae56af155f2867ac45ec41d46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4643,
"upload_time": "2025-07-25T09:29:53",
"upload_time_iso_8601": "2025-07-25T09:29:53.833589Z",
"url": "https://files.pythonhosted.org/packages/54/ac/8208c5ea359ff5b7c20a71842e76a413c73a77b2580f91d1b6484125e0aa/terraformreviewer-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 09:29:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "terraformreviewer"
}
