Metadata-Version: 2.4
Name: tf-peek
Version: 1.0.0
Summary: Add your description here
Project-URL: Repository, https://github.com/looztra/tf-peek
Author-email: Christophe Furmaniak <christophe.furmaniak@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Requires-Dist: jinja2>=3.1.6
Requires-Dist: pydantic>=2.12.5
Requires-Dist: rich>=14.3.3
Requires-Dist: typer>=0.24.1
Description-Content-Type: text/markdown

# tf-peek

`tf-peek` converts Terraform plan JSON files into human-readable Markdown reports, with configurable
resource tiers to highlight critical operations and suppress routine noise.

## Quick start

```bash
uv tool install tf-peek
terraform plan -out=tfplan && terraform show -json tfplan > plan.json
tf-peek generate plan.json
```

## Documentation

Full documentation is in the [`docs/`](docs/README.md) folder, organised using the
[Diataxis](https://diataxis.fr) framework:

| Type                                              | Purpose                                          |
| :------------------------------------------------ | :----------------------------------------------- |
| [Tutorial](docs/tutorial/first-report.md)         | Learn by generating your first report            |
| [How-to guides](docs/how-to/)                     | Step-by-step guides for common tasks             |
| [Reference](docs/reference/)                      | CLI options and configuration file specification |
| [Explanation](docs/explanation/resource-tiers.md) | Understand resource tiers and design decisions   |
