Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leg100 committed Aug 21, 2024
1 parent 75affa9 commit 246b6b1
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 9 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ A terminal user interface for terraform power users.

* Perform tasks in parallel (plan, apply, init, etc)
* Interactively manage state resources (targeted plans, move, delete, etc)
* Supports terraform, tofu and terragrunt
* Supports terragrunt dependencies
* Supports terraform, [tofu](#tofu-support) and [terragrunt](#terragrunt-support)
* Supports [terragrunt dependencies](#terragrunt-support)
* Supports workspaces
* Calculate costs using infracost
* Automatically loads workspace variable files
* Calculate costs using [infracost](#infracost-integration)
* Automatically loads [workspace variable files](#workspace-variables)
* Backend agnostic (s3, cloud, etc)

![Demo](./demo/demo.gif)
Expand Down Expand Up @@ -148,6 +148,10 @@ Press `s` to go to the state page, listing a workspace's resources.
|`Ctrl+t`|Run `terraform taint`|✓|
|`U`|Run `terraform untaint`|✓|
|`Ctrl+r`|Run `terraform state pull`|-|
|`S`|Toggle split screen|-|
|`+`|Increase split screen top pane|-|
|`-`|Decrease split screen top pane|-|
|`tab`|Switch split screen pane focus|-|

### Tasks

Expand Down Expand Up @@ -297,7 +301,7 @@ When a workspace is loaded into Pug for the first time, a task is created to inv

NOTE: Requires `infracost` to be installed on your machine, along with configured API key.

Pug integrates with infracost to provide cost estimation. Select workspaces on the workspace page and press `$` to run calculate their costs:
Pug integrates with [infracost](https://www.infracost.io/) to provide cost estimation. Select workspaces on the workspace page and press `$` to run calculate their costs:

![Infracost output screenshot](./demo/infracost_output.png)

Expand Down
Binary file modified demo/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified demo/logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified demo/state.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified demo/task_group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified demo/tasks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions demo/vhs.tape
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,8 @@ Sleep 1s

# init all modules
Ctrl+a Sleep 0.5s Type "i"
# we're taken to the init task group page, wait for a few seconds for tasks to finish (it takes longer because it is copying hefty aws provider about
Sleep 5s
# we're taken to the init task group page, wait for a few seconds for tasks to finish
Sleep 2s

# go to workspaces
Type "w" Sleep 2s
Expand All @@ -182,12 +182,12 @@ Ctrl+a Sleep 0.5s
# calculate cost
Type "$"
# user is taken to infracost task page, watch output for a few seconds
Sleep 5s
Sleep 6s
# take screen shot of infracost output (sleep to ensure page doesn't switch too soon)
Screenshot demo/infracost_output.png Sleep 0.5s

# go back to workspaces
Type "w" Sleep 0.5s
# take screen shot of workspaces (sleep to ensure page doesn't switch too soon)
Screenshot demo/workspaces_with_cost.png Sleep 0.5s
Sleep 2s
Sleep 3s
Binary file modified demo/workspaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 246b6b1

Please sign in to comment.