Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thesimonho committed Mar 18, 2024
1 parent 3573c46 commit a4e5bc6
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@

## Why?

You have multiple [Terraform](https://www.terraform.io/) projects, but they're prototypes, quick tests, and don't warrant a dedicated deployment pipeline. So, you need to push them via the command line.
You have multiple [Terraform](https://www.terraform.io/) projects, but they're prototypes, quick tests, and don't warrant a dedicated deployment pipeline. So, you need to work with them manually via the command line.

You want to quickly `validate/plan/apply` projects without constantly changing to different project directories.

You need to run `apply` on multiple projects at the same time because your latest code changes affect both services, and you don't want to forget to push one without the other.

*Tarragon is a TUI application that lets you select multiple projects to perform simultaneous Terraform actions on.*
_Tarragon is a TUI application that lets you select multiple projects to perform simultaneous Terraform actions on._

![Screenshot](images/table.png)

## Where?

Expand Down Expand Up @@ -57,4 +59,16 @@ Run `validate/plan/apply` actions using `v`, `p`, and `a` on a highlighted proje

You can select multiple projects using `space` and run actions on them at the same time using the capitalized keybinds `V`, `P`, and `A`.

**Note**: `apply` will always run with the `--auto-approve` flag, so it's recommend to first run `plan` on the project and view the output (`tab`)
**Note**: `apply` will always run with the `--auto-approve` flag, so it's recommend to first run `plan` on the project and check the output.

#### Output View

After running any Terraform command on a project, you can view the most recent output by pressing `tab`:

![Output](images/output.png)

#### Filtering

You can filter the projects table by pressing `/`, which will bring up an input field for the filter term:

![Filtering](images/filter.png)
Binary file added images/filter.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 added images/output.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 added images/table.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 a4e5bc6

Please sign in to comment.