CLI commands

--yamlPath <string>

The path to display parameters from the YAML file (optional)

--api_key <string>

An agent API key provided by Contrast (required)

--authorization <string>

Agent authorization credentials provided by Contrast (required)

--organization_id <string>

The ID of your organization in Contrast (required)

--application_id <string>

The ID of the application cataloged by Contrast (required)

--application_name <string>

The name of the application cataloged by Contrast (optional)

--catalogue_application

Catalog an application (required for catalogue)

--language <string>

Valid values are JAVA, NODE, PYTHON, RUBY and GO. (Note: The Go agent is in beta). If there are multiple project configuration files in the project_path, language is required. (required for catalogue)

--app_groups <string>

Assigns your application to one or more pre-existing groups when using the catalogue command. Group lists should be comma separated. (optional for catalogue)

--maven_settings_path <PathToFile>--

Allows you to specify an alternative location for your maven settings.xml file. Replace <PathToFile> with the full path for the file. Add this path to the full set of keys when you register your application with the CLI. (optional)

--proxy <string>

Allows for connection over a proxy server. If authentication is required, provide the username and password with the protocol, host and port. For example, http://username:password@<host>:<port>. (optional)

--host <string>

The name of the host and, optionally, the port expressed as <host>:<port>. Does not include the protocol section of the URL (https://). Defaults to app.contrastsecurity.com . (optional)

--project_path <string>

The directory root of a project/application that you want to analyze. Defaults to the current directory. (optional)

--cve_severity <level>

Combined with --report, allows the user to report libraries with vulnerabilities above a chosen severity level. For example, cve_severity medium only reports vulnerabilities at Medium or higher severity.

--cve_threshold <number>

Sets the number of CVEs allowed before a build is failed. If there are more CVEs than the threshold, the build will fail.

--fail

Fails the build if any vulnerabilities are found. Can be used in combination with cve_severity to fail builds with vulnerabilities at severity levels defined by the user.

--report

Shows a report of vulnerabilities in the application from compile time.

--silent

Silences JSON output. (optional)

-v, --version

Displays the CLI version you are currently using.

--sub_project <string>

Specifies the subproject within a gradle application. (optional)

-h, --help

Displays the help guide.