​
Introduction

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.

​
Features

  • Multiple Scanner Support: Scan with BLAST (our AI-powered scanner), Semgrep, or Snyk.
  • Issue Management: List, inspect, and manage security findings.
  • Fix Integration: View and apply AI-generated fixes for vulnerabilities right from your terminal.
  • Flexible Output: Support for both human-readable and JSON output formats for easier CI integrations.
  • CI/CD Integration: Fail builds based on severity levels or custom blocking rules.
  • Scan Management: Track scan progress and results across your projects.

​
Prerequisites

Before using the Corgea CLI, ensure you have:
  • Corgea account: An active Corgea account.
  • API Token: A valid API token from your Corgea dashboard.

​
Installation Guide

​
Install with PIP

To install the Corgea CLI tool, you can use Python’s package installer, pip. Open your terminal and run the following command: 
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/.

​
Install with Homebrew

To install the Corgea CLI tool using Homebrew, first add the Corgea tap and then install the CLI: 
brew tap Corgea/cli
brew install corgea-cli

​
Install Manually

curl -L https://github.com/Corgea/cli/releases/download/v.1.6.3/corgea_macos_aarch64.zip -o corgea.zip && unzip corgea.zip
chmod +x corgea
sudo mv corgea /usr/local/bin

​
Authentication

​
Login with your cli

To authenticate with your API token, use the following command: 
corgea login YOUR_API_TOKEN

​
Point To A Single-Tenant Instance

Customers using a single-tenant instance need to have the CLI point to their instance. 
corgea login --url https://<<Your Instance>>.corgea.app YOUR_API_TOKEN
You can also set the URL in an environment variable and the CLI will automatically detect it. 
export CORGEA_URL="https://<<Your Instance>>.corgea.app"

​
Usage

​
Commands and Options

​
Upload a Scan Report

Upload a scan report to Corgea via STDIN or a file: 
corgea upload path/to/report.json

​
Scan Your Codebase

To scan your current directory using the default BLAST scanner: 
corgea scan
To specify a different scanner, such as Semgrep: 
corgea scan semgrep
You can also set the CLI to fail on a specific severity level: 
corgea scan --fail-on CR
Or fail based on blocking rules defined in the web app: 
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. 
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. 
corgea scan --scan-type secrets
or multipe types 
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). 
corgea scan --scan-type policy --policy 1

​
Export Scan Report

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. 
corgea scan --out-format=json --out-file=report.json
The CLI currently supports html and json as output formats. 
corgea scan --out-format=html --out-file=report.html

​
Wait for a Scan

To wait for the latest in-progress scan: 
corgea wait
Or specify a scan ID to wait for: 
corgea wait --scan-id SCAN_ID

​
List Scans, Issues or SCA Issues

To list all scans for a current directory (paginated by default): 
corgea ls
To list issues for a specific scan: 
corgea ls --issues --scan-id SCAN_ID
You can also control the pagination: 
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. 
corgea list --page 1 --page-size 10 --json
To list SCA for a project or a scan use --sca-issues or ‘-c’ shorthand 
corgea list --sca-issues --page 1 --page-size 10 --json
or 
corgea list --c --page 1 --page-size 10 --json

​
Inspect a Scan or Issue

To inspect a specific scan: 
corgea inspect SCAN_ID
To inspect issues with detailed output: 
corgea inspect --issue --json --summary ISSUE_ID
For fix explanations or diffs: 
corgea inspect --issue --fix ISSUE_ID
corgea inspect --issue --diff ISSUE_ID

​
Integrating with GIT Hooks

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 
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 
corgea setup-hooks --default-config
To bypass the pre-commit check when committing, use the following command: 
git commit --no-verify

​
Additional Options

For more options and commands, use: 
corgea --help

​
Release Notes

For full release notes, please visit our GitHub releases page.