diff --git a/README.md b/README.md index 722eb01..6df74d7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# CICD Leak Scanner +# CI/CD Leak Scanner -CICD Leak Scanner is a security tool designed to scan build logs from CI/CD pipelines to identify leaks of sensitive data, tokens, or credentials. +CI/CD Leak Scanner is a security tool designed to scan build logs from CI/CD pipelines to identify leaks of sensitive data, tokens, or credentials. Due to the recent malicious actions involving [tj-actions/changed-files](https://cycode.com/blog/github-action-tj-actions-changed-files-supply-chain-attack-the-complete-guide/), we've created this tool to empower security teams to proactively scan and determine if their CI/CD pipelines have been compromised. @@ -19,6 +19,12 @@ cd cicd-leak-scanner go build -o cicd-leak-scanner . ``` +In some cases (e.g., building in a minimal Docker environment or a platform without CGO support), specify `CGO_ENABLED=0`: + +``` bash +CGO_ENABLED=0 go build -o cicd-leak-scanner . +``` + ## Usage