Skip to content

docs(contribution): enhance quick start getting-started.md #7754

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(contribution): enhance quick start getting-started.md #7754

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ To scan a directory/file on your host you have to mount it as a volume to the co
```shell
docker pull checkmarx/kics:latest
docker run -t -v "{path_to_host_folder_to_scan}":/path checkmarx/kics scan -p /path -o "/path/"
# quickstart if you are already in the project folder
docker run -t -v "$(pwd)":/path checkmarx/kics scan -p /path -o "/path/"
```

**Available Image Variants:**
Expand Down Expand Up @@ -93,4 +95,4 @@ docker run -t -v {path_to_host_folder}:/path checkmarx/kics:latest scan -p /path
- [Explore the queries internals](queries.md) for better understanding how KICS works.
- [Create a new query](creating-queries.md) to learn how to create your own custom queries.
- [Explore the output results format](results.md) and quickly fix the issues detected.
- [Contribute](CONTRIBUTING.md) if you want to go the extra mile.
- [Contribute](CONTRIBUTING.md) if you want to go the extra mile.
Loading