Corgea CLI is a powerful developer tool that helps you find and fix security vulnerabilities in your code. Using our AI-powered scanner (BLAST) and platform, Corgea identifies complex security issues like business logic flaws, authentication vulnerabilities, and other hard-to-find bugs. The CLI provides commands to scan your codebase, inspect findings, interact with fixes, and much more - all designed with a great developer experience in mind.
To install the Corgea CLI tool, you can use Python’s package installer, pip. Open your terminal and run the following command:
Copy
Ask AI
pip install corgea-cli
This command fetches the Corgea CLI package from PyPI (Python Package Index) and installs it on your system. You can find more details about the package on its PyPI page: https://pypi.org/project/corgea-cli/.
To scan your current directory using the default BLAST scanner:
Copy
Ask AI
corgea scan
To specify a different scanner, such as Semgrep:
Copy
Ask AI
corgea scan semgrep
You can also set the CLI to fail on a specific severity level:
Copy
Ask AI
corgea scan --fail-on CR
Or fail based on blocking rules defined in the web app:
Copy
Ask AI
corgea scan --fail
By default, the scan command scans the entire project. However, if you only want to scan your changes before committing, you can use the —only-uncommitted option.
Copy
Ask AI
corgea scan --only-uncommitted
The regular BLAST scan includes multiple scans:
Blast Base AI Scan
PolicyIQ Scan
Malicious Code Detection Scan
Secrets Detection Scan
Personally identifiable information (PII) Detection Scan
By default, all these scans run (if they are enabled for your company account plan). However, the CLI provides the flexibility to run a scan targeting one or more types with the —scan-type option.
Copy
Ask AI
corgea scan --scan-type secrets
or multipe types
Copy
Ask AI
corgea scan --scan-type blast,policy,secrets,pii
To target specific policies with a policyIQ scan, use the —policy option. This allows you to focus on one or more policies by passing their ID(s).
The Corgea CLI allows you to export scan results to a file, which is particularly useful when running the tool within a CI pipeline. You can do this using the —out-format and —out-file options.
To list all scans for a current directory (paginated by default):
Copy
Ask AI
corgea ls
To list issues for a specific scan:
Copy
Ask AI
corgea ls --issues --scan-id SCAN_ID
You can also control the pagination:
Copy
Ask AI
corgea list --page 1 --page-size 10
Note: The --json option is available for commands like list and inspect to output results in JSON format, which is useful for integrations and automation.
Copy
Ask AI
corgea list --page 1 --page-size 10 --json
To list SCA for a project or a scan use --sca-issues or ‘-c’ shorthand
Copy
Ask AI
corgea list --sca-issues --page 1 --page-size 10 --json
To ensure code quality and security, you can integrate Corgea CLI with your Git workflow using pre-commit hooks. This feature allows you to scan your code changes before committing or pushing them. To set up the pre-commit hook, simply run
Copy
Ask AI
corgea setup-hooks
When setting up the pre-commit hook, you will be prompted to enter your preferred configurations for the scan. To quickly set it up with the default settings, which include scan types for PII and secrets, and fail levels set to CR, HI, ME, and LO, you can run
Copy
Ask AI
corgea setup-hooks --default-config
To bypass the pre-commit check when committing, use the following command: