Skip to content

Commit

Permalink
Merge pull request #132 from lkurzyniec/feature/run-from-paln-in-readme
Browse files Browse the repository at this point in the history
added info to README file how to run on plan file
  • Loading branch information
im2nguyen authored Oct 9, 2023
2 parents 7867d7c + 36f6579 commit 4be7473
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,23 @@ $ docker run --rm -it -p 9000:9000 -v $(pwd):/src im2nguyen/rover

Once Rover runs on `0.0.0.0:9000`, navigate to it to find the visualization!

### Run on Terraform plan file

Use `-planJSONPath` to start Rover on Terraform plan file. The `plan.json` file should be in Linux version - Unix (LF), UTF-8.

First, generate the plan file in JSON format.

```
$ terraform plan -out plan.out
$ terraform show -json plan.out > plan.json
```

Then, run Rover on it.

```
$ docker run --rm -it -p 9000:9000 -v $(pwd)/plan.json:/src/plan.json im2nguyen/rover:latest -planJSONPath=plan.json
```

### Standalone mode

Standalone mode generates a `rover.zip` file containing all the static assets.
Expand Down

0 comments on commit 4be7473

Please sign in to comment.