Skip to main content

Contrast CLI for CVE Shield

Contrast CLI for CVE Shield is a command-line tool, distributed via Homebrew on macOS and Linux, that instruments Docker containers with a Contrast agent for prospects evaluating CVE Shield Free.

Note

This CLI installs separately from the existing Contrast CLI used by Contrast enterprise customers to scan code and open-source dependencies in static application security testing (SAST).

The Contrast CLI commands for CVE Shield are built to help Free tier prospects who find instrumenting their first application challenging. Paid customers can use them too, but they are intended for temporary debugging, troubleshooting, and evaluation. For production rollouts, keep using your usual agent deployment method.

Installing the Contrast CLI for CVE Shield does not install, remove, or otherwise affect any instance of the existing Contrast CLI. There is no shared configuration or overlapping commands between them.

Before you begin

Make sure you have everything you need before you start.

  • macOS or Linux with a UI and browser

  • Homebrew

  • A Java application (optional if running a demo)

  • Docker Engine

  • Docker Desktop (optional)

  • A Contrast account and the URL of your Contrast instance

  • A web browser on the same machine for signing in to Contrast

Install the CLI

Install the CLI from Homebrew by running the following commands:

brew tap contrastsecurity/tap
brew install contrast-cli

Sign in to Contrast

After you install the CLI, run the following command to authenticate it with your Contrast account:

contrast-cli configure

After signing in, close the browser window and return to your terminal window.

See CLI commands for CVE Shield to learn more about available commands.

In this section: