Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update(docs): running kics documentation update #6886

Merged
merged 22 commits into from
Feb 26, 2024
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
0bdefe3
running kics documentation update
ArturRibeiro-CX Feb 15, 2024
84d068a
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 16, 2024
f6089b1
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 19, 2024
a434c99
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 19, 2024
73edc0e
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 21, 2024
c4b7b7b
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 22, 2024
1da1b55
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 23, 2024
729bc01
Delete docs/results.md
ArturRibeiro-CX Feb 23, 2024
c78826b
Revert "Delete docs/results.md"
ArturRibeiro-CX Feb 23, 2024
a876781
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 23, 2024
9ad3fa1
Merge branch 'master' of https://github.com/Checkmarx/kics into docum…
ArturRibeiro-CX Feb 23, 2024
1836f7e
Merge branch 'documentation_update_running' of https://github.com/Che…
ArturRibeiro-CX Feb 23, 2024
8edfea7
addition of running kics with big zip file
ArturRibeiro-CX Feb 23, 2024
1511fe0
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 23, 2024
ce4cd2e
Merge branch 'master' of https://github.com/Checkmarx/kics into docum…
ArturRibeiro-CX Feb 23, 2024
011e19d
Merge branch 'documentation_update_running' of https://github.com/Che…
ArturRibeiro-CX Feb 23, 2024
66a13d0
changes to running kics link problems
ArturRibeiro-CX Feb 23, 2024
c306ff4
changes to docker run instruction to be more clear
ArturRibeiro-CX Feb 23, 2024
0348710
Typo on the first link saying KICS instead of Docker
ArturRibeiro-CX Feb 23, 2024
645bc19
remove unnecessary comments
ArturRibeiro-CX Feb 23, 2024
6626dae
Merge branch 'master' into documentation_update_running
ArturRibeiro-CX Feb 23, 2024
498ed47
Merge branch 'master' into documentation_update_running
gabriel-cx Feb 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions docs/running-kics.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,36 @@ Available archive formats:
- `xz`

```
docker run -t -v {path_to_zip}:/path checkmarx/kics scan -p /path/{name_of_zip_file}
To scan a zip file, we would use this instruction:

docker run -t -v "{path_to_folder_of_zip}:/path" checkmarx/kics:latest scan -p /path/{name_of_zip_file}

-t: Docker command to allocate a pseudo-TTY.

-v "{path_to_folder_of_zip}:/path": Mounts the directory containing the zip file to be scanned into the Docker container.

checkmarx/kics:latest: Specifies the Docker image to use, which is the latest version of KICS available.

scan -p /path/{name_of_zip_file}: initiates a scan on the zip file we provided, considering it's folder path.
```

```
To scan a file named "Example", we would use this instruction:

docker run -t -v "{path_to_folder_of_file_Example}:/path" checkmarx/kics:latest scan -p /path/Example

-t: Docker command to allocate a pseudo-TTY.

-v "{path_to_folder_of_file_Example}:/path": Mounts the directory containing the file to be scanned into the Docker container.

checkmarx/kics:latest: Specifies the Docker image to use, which is the latest version of KICS available.

scan -p /path/Example: initiates a scan on the "Example" file we provided, considering it's folder path.
```

More information on Docker CLI can be seen [here](https://docs.docker.com/engine/reference/commandline/cli/)

More information can be seen [here](https://github.com/hashicorp/go-getter#unarchiving)
More information on Go getter can be seen [here](https://github.com/hashicorp/go-getter#unarchiving)

### S3

Expand Down
Loading