tf-peek Documentation¶

tf-peek is a CLI tool that converts Terraform plan JSON files into human-readable Markdown reports, with configurable resource tiers for focused review.

This documentation follows the Diataxis framework. Content is organised into four types based on what you need:

Tutorial — Learn by doing¶

Start here if you are new to tf-peek.

Your first Terraform plan report

How-to guides — Accomplish a specific task¶

Step-by-step directions for common tasks. These guides assume you are already familiar with the basics.

Reference — Technical facts and specifications¶

Complete, accurate descriptions of the CLI and configuration format. Use these while working.

Explanation — Background and concepts¶

Read these to understand why things work the way they do.

Resource tiers

Architecture¶

Internal design documentation for contributors: