Skip to content

Commit

Permalink
Merge pull request #551 from Checkmarx/docs-update
Browse files Browse the repository at this point in the history
Docs update
  • Loading branch information
elit-cx authored Nov 30, 2020
2 parents 2b11d34 + 632f06c commit 609afb6
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,38 @@ This section describes the installation steps for getting KICS up and running.
go run ./cmd/console/main.go -p <path-of-your-project-to-scan> -o <output-results.json>
```

<!--

#### Release

```
TBD
KICS release process is pretty straightforward.
When we're releasing a new version, we'll pack KICS executables for both Linux and Windows operating systems.
Our security queries will be included in the ZIP files and tarballs, so that you can scan your IaC code with the out-of-the-box queries
So all you need is:
1. Go to KICS [releases](https://github.com/Checkmarx/kics/releases)
2. Click on latest release
3. Download KICS binaries based on your OS
4. Extract files
5. Run kics executable with the cli options as decribed below
```
kics.exe -p <path-of-your-project-to-scan> -o <output-results.json>

#### Docker
```
KICS is also available as a Docker image and can be used as follows
```
TBD

#### Docker

KICS is also available as a [Docker image](https://hub.docker.com/r/checkmarx/kics) and can be used as follows:

``txt
docker pull checkmarx/kics:latest
docker run -v {​​​​path_to_local_folder_to_scan}​​​​:/path checkmarx/kics:latest -p "/path" -o "/path/results.json"
```
-->
## CLI Options
Expand Down

0 comments on commit 609afb6

Please sign in to comment.