Skip to main content

Terraform Textual User Interface

Project description

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)
  • Added a fullscreen mode to allow easier copying of resource / plan parts
  • Fixed: search through full module names
  • Fixed: Copy to clipboard crashes on some systems

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

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

tftui-0.12.6.tar.gz (29.6 kB view details)

Uploaded Source

Built Distribution

tftui-0.12.6-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file tftui-0.12.6.tar.gz.

File metadata

  • Download URL: tftui-0.12.6.tar.gz
  • Upload date:
  • Size: 29.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for tftui-0.12.6.tar.gz
Algorithm Hash digest
SHA256 8bc3f7278e0c6ff076d0f2b46dc0e68501fa87cff5204a96dfb7fe1a40bf0470
MD5 891bd5faed4360a07a000038c670b5fc
BLAKE2b-256 0e47e9bda2e36940a797fb24a28b5af4bbd418515164df33937a1e8c1c407206

See more details on using hashes here.

File details

Details for the file tftui-0.12.6-py3-none-any.whl.

File metadata

  • Download URL: tftui-0.12.6-py3-none-any.whl
  • Upload date:
  • Size: 29.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for tftui-0.12.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4c3f169b48668af74174ac35aa1827bf60a545d2be09f2ec1fe34ef736d9bb41
MD5 0ecf95dd2d17610596e126046f021b76
BLAKE2b-256 34beeb71d9813a8a762b4004561b027e048833ac1a38aac2d4356ccc3f6d8798

See more details on using hashes here.

Supported by

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