README
¶
Gatecheck
Gatecheck automates report validation in a CI/CD Pipeline by comparing security findings to pre-determined thresholds. It also provides report aggregation, artifact integrity, and deployment validation. Gatecheck is stateless so self-hosting and provisioning servers is not required.
Getting Started
The fastest way to get started with Gatecheck is to download the pre-built binaries for your target system.
cd <target install dir>
curl -L <OS Specific Release>.tar.gz | tar xz
./gatecheck
./gatecheck --help
The Gatecheck CLI supports --help for every command for more detail usage.
Generate a configuration file with the default thresholds set
gatecheck config init > gatecheck.yaml
Summarize Reports with List
gatechec ls --help
List with EPSS Scores is support for Grype and Cyclondex reports
Validation
List with EPSS Scores is support for Grype and Cyclondex reports
Bundling Artifacts
Bundling Artifacts produces a gzipped tarball with an associated manifest for metadata.
Directories
¶
| Path | Synopsis |
|---|---|
|
The root file contains common helper functions used by other commands.
|
The root file contains common helper functions used by other commands. |
|
gatecheck
Package main executes the CLI for gatecheck
|
Package main executes the CLI for gatecheck |
|
pkg
|
|
|
archive
Package archive provides the logic for Gatecheck Bundles
|
Package archive provides the logic for Gatecheck Bundles |
|
validate
Package validate provides a generic implementation for any object type using validation rules
|
Package validate provides a generic implementation for any object type using validation rules |
Click to show internal directories.
Click to hide internal directories.