Metadata-Version: 2.4
Name: tfanalyse
Version: 0.3.0
Summary: Lightweight command-line utility to analyse Terraform plan files
License-File: LICENSE.txt
Author: Tobias Waslowski
Author-email: tobiaswaslowski@gmail.com
Requires-Python: >=3.10,<4.0
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: Programming Language :: Python :: 3.14
Requires-Dist: click (>=8.1.7,<9.0.0)
Description-Content-Type: text/markdown

![Build](https://github.com/twaslowski/tfanalyse/actions/workflows/test.yml/badge.svg)
![Coverage](./test/coverage.svg)

# tfanalyse

tfanalyse is a lightweight command-line utility to summarise the contents of a Terraform plan.
It allows you to quickly see what resources are being created, updated, or destroyed, and what changes are being made to them.

## Installation

You can install this tool using pip:

```bash
pip install tfanalyse
```

You can also install it from source:

```bash
git clone git@github.com:twaslowski/tfanalyse.git
pip install ./tfanalyse/   # global installation
poetry install  # installs in your given poetry virtual environment
```

## Usage

To use the tool, simply run it with the path to the Terraform plan file as an argument:

```
terraform plan -out=plan.tfplan
tfanalyse plan.tfplan
```

This will output a summary of the plan, showing the resources that are being created, updated, or destroyed.
You can list only the resources that would be destroyed by adding the `--destroy-only` flag.

## Development

This is a very minimal tool for now. I will develop it to be useful for me, and I hope that others may find it useful
too. If you would like to develop it further, feel free to fork the repository and submit a pull request.

You can set up the local development environment using [Poetry](https://python-poetry.org/): Simply run `poetry install`.

