CLI parameters

The CLI includes command line help, including the glossary of commands shown below, which displays with the --h or --help option.

Parameter

Description

--yamlPath string

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

--cli_api_key string

An agent API key provided by Contrast (required)

--cli_authorization string

Agent authorization credentials provided by Contrast (required)

--cli_organization_id string

The ID of your organization in Contrast (required)

--cli_application_id string

The ID of the application catalogued by Contrast (required)

--cli_application_name string

The name of the application catalogued by Contrast (optional)

--cli_catalogue_application

Catalogues an application (required for catalogue)

--cli_language string

Application language, such as JAVA, DOTNET, NODE, PYTHON, RUBY. Provide this when cataloguing an application. (required for catalogue)

--cli_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)

--cli_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)

--cli_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)

Only HTTPS connections are supported at this time.

--cli_project_path string

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

--silent

Silences JSON output (optional)

-v, --version

Displays the CLI version you are currently on

-h, --help

Displays the help guide

Note

Parameters may need to be quoted to avoid issues with special characters