Skip to content

Commit

Permalink
feat(general): Added the jq requirement note (#6447)
Browse files Browse the repository at this point in the history
Added the jq requirement note

the plan file needs to be pretty printed in order to see the issue in the code block. If the plan file is in raw json then the code block doesn't appear. This isn't obvious in the documentation. I added a note.

Co-authored-by: itai1357 <[email protected]>
Co-authored-by: Chanan Merari <[email protected]>
  • Loading branch information
3 people authored Dec 8, 2024
1 parent b1a44b5 commit 2eeb83f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/2.Basics/Installing Checkov.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ check: CKV_AWS_21: "Ensure all data stored in the S3 bucket have versioning enab
Guide: https://docs.prismacloud.io/en/enterprise-edition/policy-reference/aws-policies/s3-policies/s3-16-enable-versioning
```

If you have installed jq, you can convert a JSON file into multiple lines with the command `terraform show -json tf.plan | jq '.' > tf.json`, making it easier to read the scan result.
If you have installed jq, you can convert a JSON file into multiple lines with the command `terraform show -json tf.plan | jq '.' > tf.json`, making it easier to read the scan result. NOTE: `jq` is required to show the code block as seen below.

```json
checkov -f tf.json
Expand Down

0 comments on commit 2eeb83f

Please sign in to comment.