Skip to content

Commit

Permalink
docs: add brew install kics instructions
Browse files Browse the repository at this point in the history
I had installed kics from tap checkmarx/homebre-tap and did not understand
it was now available on homebrew-core. I suggest to add this to the
documentation, along with migration instructions.
#
#
  • Loading branch information
gforien-externe authored and gforien committed Jun 26, 2024
1 parent 9453cb9 commit 8db070d
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,20 @@ Another option is [rebuilding the dockerfile](https://github.com/Checkmarx/kics/
./bin/kics scan -p '<path-of-your-project-to-scan>' --report-formats json -o ./results
```

#### [Deprecated] Homebrew
#### Homebrew

KICS is available on Checkmarx [homebrew-tap](https://github.com/Checkmarx/homebrew-tap) only for versions until 1.5.1. It can be used as follows:
KICS is available on homebrew-core. Install it with:

```sh
brew install kics
```
brew install Checkmarx/tap/kics

If you installed KICS from Checkmarx [homebrew-tap](https://github.com/Checkmarx/homebrew-tap) (for versions until 1.5.1), you can use the new formula as follows:

```sh
brew remove kics
brew untap Checkmarx/tap/kics
brew install kics
```

To use KICS default queries add the KICS_QUERIES_PATH environmental variable to your shell profile, e.g:
Expand Down

0 comments on commit 8db070d

Please sign in to comment.