From de8e375a7d76e202da4eb55b7b30da25249b9090 Mon Sep 17 00:00:00 2001 From: Rui Chen Date: Tue, 8 Sep 2020 23:02:18 -0400 Subject: [PATCH] chore(docs): add homebrew installation --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 569ade780..dc81d42ec 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Detect compliance and security violations across Infrastructure as Code to mitig ## Installing Terrascan's binary for your architecture can be found on the [releases](/~https://github.com/accurics/terrascan/releases) page. Here's an example of how to install it: -``` +```sh $ curl --location /~https://github.com/accurics/terrascan/releases/download/v1.0.0/terrascan_1.0.0_Darwin_x86_64.tar.gz --output terrascan.tar.gz $ tar -xvf terrascan.tar.gz x CHANGELOG.md @@ -45,17 +45,25 @@ $ go get -u github.com/accurics/terrascan/cmd/terrascan $ terrascan ``` +### Install via `brew` + +[Homebrew](https://brew.sh/) users can install by: + +```sh +$ brew install terrascan +``` + ### Docker Terrascan is also available as a Docker image and can be used as follows -``` +```sh $ docker run accurics/terrascan ``` ### Building Terrascan Terrascan can be built locally. This is helpful if you want to be on the latest version or when developing Terrascan. -``` Bash +```sh $ git clone git@github.com:accurics/terrascan.git $ cd terrascan $ make build @@ -66,14 +74,14 @@ $ ./bin/terrascan To scan your code for security issues you can run the following -``` +```sh $ terrascan scan -t aws ``` Terrascan will exit 3 if any issues are found. The following commands are available: -``` +```sh $ terrascan Terrascan