The following environment variables are set by an administrator.
| Name | Description |
|---|---|
POLARIS_ACCESS_TOKEN
|
The token value. If this environment variable is set, it takes precedence over
other sources such as file and keychain. For example,
POLARIS_ACCESS_TOKEN always takes precedence over the
POLARIS_ACCESS_TOKEN_FILE environment variable. |
POLARIS_ACCESS_TOKEN_FILE
|
The file containing the access token to use when authenticating. If this value
is not set, the platform-credential store is used. For Windows, this is credential
manager; for MacOS, it is keychain; and for Linux, it is a file containing the
access token. The default is $POLARIS_HOME/.access_token
|
POLARIS_HOME
|
The home directory to use for the tool. This directory is used to store locally
downloaded tools packages, and the access token file for Linux. The default is
$HOME/.blackduck/polaris. If you create a directory and designate
it as POLARIS_HOME, be sure to create the directory before changing
the environment variable. |
POLARIS_SERVER_URL
|
URL of the Coverity on Polaris server to use. This value can be useful for automation. If this environment variable is set to the Coverity on Polaris URL, all the Coverity on Polaris CLI commands point to that URL. If this variable is not set, then the setup, capture, and analyze commands prompt the user to enter the Coverity on Polaris URL. |
POLARIS_TOKEN_ATTEMPTS
|
The number of times users are prompted for the access token after the given
access token is invalid. If the access token is entered using the console, users are
prompted at most POLARIS_TOKEN_ATTEMPTS - 1 times. If the access
token is read from another location such as a file, users are prompted at most
POLARIS_TOKEN _ATTEMPTS times. |
POLARIS_USER_INPUT_TIMEOUT_MINUTES
|
The time in minutes allowed for a user to specify input. The default value is five minutes. |
POLARIS_UPLOAD_SERVICE_URL |
The URL to use for uploading capture data when it is not sent directly to the Coverity on Polaris server. For example the URL of a load-balancing server. (This can also be set in the polaris.yml file.) |
Note: Coverity on Polaris CLI uses the underlying system's proxy
settings. So if your CI container requires some proxy settings to connect to internet ,
they should be set in advance, before running CLI. There are no additional proxy settings
needed by Coverity on Polaris CLI.