README
¶
Debricked CLI
Safety through commandline.
debricked.com »
debricked is Debricked's command line interface. It brings open source security, compliance and health to your
project via the command prompt.
Installation
Check out the releases page. Choose the asset that is applicable for your system. Below follow some common ways to install the CLI.
Linux
curl -L https://github.com/debricked/cli/releases/latest/download/cli_linux_x86_64.tar.gz | tar -xz debricked
./debricked
Mac
curl -L https://github.com/debricked/cli/releases/latest/download/cli_macOS_arm64.tar.gz | tar -xz debricked
./debricked
Windows
- Download zip
- Unpack zip
.\debricked
Docker
docker pull debricked/cli:1-resolution-debian
Scan
Once you've installed the CLI, you're ready to scan your project. You can scan a local project, or integrate a scanning mechanism in your CI/CD pipeline.
- Sign up to Debricked
- Create an access token
debricked scan -t <access-token>
When the scan is complete, you will see the total number of vulnerabilities found and a list of automation rules that have been evaluated. Read more about automations here.
Docker
To make a scan directly through Docker based on your current working directory, you can use the following command:
docker run -v $(pwd):/root debricked/cli:1-resolution-debian debricked scan -t <access-token>
CI/CD integration
If you would rather use debricked in your CI/CD pipelines, check out the templates.
Contributing
Thank you for your interest in making Debricked CLI even better! Read more about contributing to the project here.
Also, make sure to check out the Debricked Portal. There, you can share your great ideas with us!
Directories