Skip to main content

An interactive TUI for Terraform and OpenTofu beginners with enterprise-grade features

Project description

infra-guide

License: MIT Python 3.8+ Version

infra-guide is a product-style CLI and interactive command center for Terraform and OpenTofu. It blends guide-first workflows, direct subcommands, workspace diagnostics, and automation-friendly commands so the tool works for both learning and day-to-day operations.

Features

  • Real CLI surface with working --help, subcommands, and passthrough args
  • Interactive themed dashboard with readiness, backend, lock file, workspace, state, recent commands, and favorites
  • doctor mode for project health checks and actionable recommendations
  • Persistent theme customization with aurora, sunset, forest, and mono
  • Command history and favorites with rerun support inside the TUI
  • Pre-apply cost insight that analyzes a saved plan when available and clearly says when exact pricing cannot be predicted safely
  • Guide mode for init, plan, apply, and destroy
  • Direct support for history, theme, init, plan, apply, destroy, fmt, state, workspace, and cicd
  • Drift detection, validation, state exploration, and workspace management
  • Local-only execution with no telemetry and no cloud credentials required

Demo

infra-guide  Command Center  v0.4.0
Tool: tofu (OpenTofu v1.11.5)
Workspace: default
Directory: ./envs/dev

Environment      Project Signals     Next Step
Workspace: dev   Config files: 8     Ready to operate
Readiness: READY Backend: YES        Recommended flow:
                 Lock file: YES      doctor -> plan -> apply

Command Palette
1  doctor     Workspace health check with guidance   LOW
2  init       Initialize providers and backend       LOW
3  plan       Preview infrastructure changes         LOW
4  apply      Apply changes with cost insight        MEDIUM
5  destroy    Remove managed infrastructure          HIGH
10 history    Rerun recent or favorite commands      LOW
11 theme      Switch the interface theme             LOW

Installation

pipx

pipx install infra-guide
infra-guide --help

From source

git clone https://github.com/iamtejas23/infra-guide.git
cd infra-guide
python3 -m venv venv
source venv/bin/activate
pip install .
infra-guide

Usage

Interactive mode

infra-guide

Direct CLI mode

infra-guide status
infra-guide doctor --with-drift
infra-guide history --favorites
infra-guide theme --set sunset
infra-guide guide plan
infra-guide init --upgrade
infra-guide plan --out tfplan
infra-guide apply --plan-file tfplan --yes
infra-guide workspace --select staging
infra-guide fmt --check

Passing through raw flags

infra-guide plan -- --target=module.network
infra-guide init -- --backend-config=env/dev.backend.hcl
infra-guide destroy -- --target=aws_instance.temporary

Suggested workflow

  1. Run infra-guide doctor to understand workspace readiness.
  2. Run infra-guide init if the directory has not been initialized.
  3. Run infra-guide plan --out tfplan to preview and save changes.
  4. Run infra-guide apply --plan-file tfplan --yes when ready to execute.

Commands

Command Description Risk
status Show a fast workspace summary Low
doctor Run health diagnostics and recommendations Low
guide <command> Show best practices and examples for a command Low
history Show recent commands and favorites Low
theme Show or change the active TUI theme Low
init Initialize providers, modules, and backend Low
plan Preview infrastructure changes Low
apply Create or update infrastructure Medium
destroy Delete managed infrastructure High
validate Run pre-flight checks Low
drift Detect infrastructure drift Low
state Show state overview, list, tree, or resource detail Low
workspace List, create, select, or delete workspaces Medium
fmt Format Terraform/OpenTofu files Low
cicd Run a pipeline-friendly init/validate/plan flow Medium

Feature notes

Doctor and status

infra-guide status
infra-guide doctor
infra-guide doctor --with-drift

status is lightweight. doctor adds validation and exits non-zero when critical checks fail.

Themes, history, and favorites

infra-guide theme --list
infra-guide theme --set forest
infra-guide history
infra-guide history --favorites

The TUI also exposes theme switching, favorite toggling, and rerun flows directly from the interactive dashboard.

Apply cost insight

infra-guide plan --out tfplan
infra-guide apply --plan-file tfplan --yes

Before apply, infra-guide now shows a cost-impact panel. It uses the saved plan when possible, but it intentionally avoids claiming exact AWS pricing unless live pricing context exists.

State explorer

infra-guide state
infra-guide state --list
infra-guide state --tree
infra-guide state --detail aws_instance.web

Workspace management

infra-guide workspace --list
infra-guide workspace --create dev
infra-guide workspace --select prod
infra-guide workspace --delete staging

CI/CD mode

infra-guide cicd
infra-guide cicd --skip-init
infra-guide cicd --skip-validation

Security and privacy

  • No telemetry
  • No network calls beyond your Terraform/OpenTofu usage
  • No credential handling inside infra-guide
  • Local execution only
  • Open source and auditable

Development

git clone https://github.com/iamtejas23/infra-guide.git
cd infra-guide
python3 -m venv venv
source venv/bin/activate
pip install -e ".[dev]"
pytest
black infra_guide/
mypy infra_guide/

Project structure

infra-guide/
├── infra_guide/
│   ├── cli.py
│   ├── project_inspector.py
│   ├── runner.py
│   ├── ui.py
│   ├── validators.py
│   ├── drift_detector.py
│   ├── state_explorer.py
│   ├── workspace_manager.py
│   ├── cicd.py
│   └── guides/
├── pyproject.toml
└── README.md

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

infra_guide-0.4.0.tar.gz (43.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

infra_guide-0.4.0-py3-none-any.whl (47.6 kB view details)

Uploaded Python 3

File details

Details for the file infra_guide-0.4.0.tar.gz.

File metadata

  • Download URL: infra_guide-0.4.0.tar.gz
  • Upload date:
  • Size: 43.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for infra_guide-0.4.0.tar.gz
Algorithm Hash digest
SHA256 52c06eee700250076f373ed8c36377ea2ed8670d5670accbc8ff7db3648b1892
MD5 ecba07039e97c2ed30b17a3ddbe10199
BLAKE2b-256 18240b28dbf42cb828b448460046a23a4980df45d0e77f3c4e978dd7bddf7520

See more details on using hashes here.

File details

Details for the file infra_guide-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: infra_guide-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 47.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for infra_guide-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69a173480d6df5f33d6397ecc3e7bedb87255810ee1f1e7ecddacb5519b6dd7d
MD5 12bc9198a7ad99d2cf4bb448db8d3417
BLAKE2b-256 bbe8fc704713cd1bf7dd3402173bf40cd3ef4a2638bc0bbd6edc2e9ac6be1bef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page