From 12105e6c1f70cd3d710ebe3330a52d4c8ffb33f4 Mon Sep 17 00:00:00 2001 From: gforien-externe Date: Wed, 26 Jun 2024 16:58:18 +0200 Subject: [PATCH] docs: add `brew install kics` instructions 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. # # --- docs/documentation.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/documentation.md b/docs/documentation.md index fa3e55a44ee..6a3d95461f9 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -52,12 +52,20 @@ Another option is [rebuilding the dockerfile](https://github.com/Checkmarx/kics/ ./bin/kics scan -p '' --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: