Skip to main content

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

Project description

infra-guide

infra-guide logo

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.5.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.5.0.tar.gz (2.3 MB 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.5.0-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for infra_guide-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a07e7979be2971b8a062e910e3c09f454eff6a6f3ff784cee2b8c3ee238258a2
MD5 0c148569be93cf58f8bab986aba25854
BLAKE2b-256 e6270cadf90b0155da86dcb5eefbae2e9aeb3b0e3cf02b09088051dbd6d7cc9e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: infra_guide-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44917b4162f1f313b00c9a0af6a20b0a848e4d7440552406c648611bd19cc559
MD5 3f7585998b9b0e2ab9adba824e03e56c
BLAKE2b-256 469ab0272f59bcd43c726eb693be4b95f54406244bbf58b00d25111305b5c8fb

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