• Stars
    star
    1,005
  • Rank 45,700 (Top 1.0 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 1 year ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Terraform textual UI

TFTUI - The Terraform textual UI

PyPI version GitHub PyPI - Downloads

TFTUI is a powerful textual UI that empowers users to effortlessly view and interact with their Terraform state.

With its latest version you can easily visualize the complete state tree, gaining deeper insights into your infrastructure's current configuration. Additionally, the ability to search the tree and inspect individual resource states allows you to focus on specific details for better analysis and management. It's also possible to select specific resources and perform actions such as tainting, untainting and deleting them. Finally, you are now able to create and apply plans directly from the UI.

Key Features

  • Comprehensive display of the entire Terraform state tree
  • Effortlessly view and navigate through a single resource state
  • Search the state tree and resource definitions
  • Create plans, present them in full colors and apply them directly from the TUI
  • Single/multiple resource selection
  • Operate on resources: taint, untaint, delete, destroy
  • Support for Terraform wrappers (e.g. terragrunt)

Changelog (latest versions)

Version 0.12

  • Enabled targeting specific resources for plan creation
  • Introducing cli argument: tfvars file
  • Added destroy functionality
  • Added a help screen
  • Added dynamic value for "targets" checkbox (checkbox is marked when resources are selected)
  • Added a short summary of the suggested plan before applying it
  • Added a redacted error tracker on unhandeled exceptions (only when usage reporting is enabled)
  • Fixed: search through full module names

Version 0.11

  • Added support for creating plans (in vivid colors!) and applying them
  • Changed the confirmation dialog to a modal screen
  • Added coloring to tainted resources considering some terminals can't display strikethrough correctly
  • Improved loading screen mechanism

Version 0.10

  • Perform actions on a single highlighted resource without pre-selecting it
  • User interface overhaul: added logo, fixed coloring and loading indicator
  • Added resource selection via the space key and tree traversal via the arrow keys
  • Added a lightmode command-line argument
  • Added a debug log command-line argument
  • Copy to clipboard now copies the resource name in the tree view
  • Fixed a bug in the remove resource functionality
  • Fixed a bug in the parsing mechanism (colons, dots)
  • Refactor: globals

Demo

Installation

Tool Install Upgrade Run
Homebrew brew install idoavrah/homebrew/tftui brew upgrade tftui cd /path/to/terraform/project && tftui
PIP pip install tftui pip install --upgrade tftui cd /path/to/terraform/project && tftui
PIPX pipx install tftui pipx upgrade tftui cd /path/to/terraform/project && tftui

Usage Tracking

  • TFTUI utilizes PostHog to track usage of the application.
  • This is done to help us understand how the tool is being used and to improve it.
  • No personal data is being sent to the tracking service. Returning users are being uniquely identified by a generated fingerprint.
  • You can opt-out of usage tracking completely by setting the -d flag when running the tool.

Star History

Star History Chart