Skip to content

Commit

Permalink
Merge pull request #315 from chenrui333/add-homebrew-installation
Browse files Browse the repository at this point in the history
add homebrew support
  • Loading branch information
kanchwala-yusuf authored Sep 11, 2020
2 parents f6c1acb + de8e375 commit 2953c19
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 2953c19

Please sign in to comment.