These docs are for v1.1. Click to read the latest docs for v1.2.

Integrating with an On-Premise Ticketing Service

This command connects Bright with a ticketing service deployed on a local server (currently only the On-Premise Jira is supported): bright-cli integration [options]. The repositories of the connected service can then be integrated with the Bright projects to be used as endpoints for scan reports (details of detected security vulnerabilities).

For more information about the integration capabilities, see Ticketing Integrations.

Script Example

bright-cli integration --access-key $INTEGRATION_ACCESS_KEY --base-url --user $USERNAME --password $PASSWORD --token $API_TOKEN



  • Sample variables are marked with a $. You must substitute them for your real values.
  • If your Jira username or password includes any special characters (for example, "pa$$word"), enclose the entire username or password in single quotes.


--clusterBright cluster (domain name).

--access-key=integrationKeyThe unique identifier generated in the Jira integration config dialog box in the Bright app.
Required to authorize Bright in the On-Premise Jira (local Jira Server).
--type=jiraIntegration service type (currently only JIRA is supported)
--base-url=serviceUrlBase URL to the Jira instance API
--user=serviceUserNameYour username for a local Jira Server or email for the Atlassian Jira Cloud
--password=serviceUserPasswordYour password for a local Jira Server or Jira API token for the Atlassian Jira Cloud
--token=apiKey, -t=apiKeyBright organization API key or personal API key with the bot scope.
The botscope enables a connection between Bright and Bright CLI.
--daemon, -dRuns the integration in a daemon mode
--config=pathToConfigSpecifies the path to the configuration file. By default, the CLI tries to discover the configuration in thepackage.json in the root directory of your application or a separate file by a specified name in the working directory. See Configuration Files for more information.
--log-level =0/1/2/3/4/silent/
Allows setting a level of logs for reports. Bright will only show the logs of a level higher than the one specified. The options to select : 0, 1, 2, 3, 4, "silent", "error", "warn", "notice", and "verbose".

Default: 3
--insecureAllows the Bright CLI to continue working even if the server connection is considered insecure.
--proxy=socksProxyUrlSOCKS URL to proxy all traffic.

Note: SOCKS4, SOCKS5, SOCKS4a, SOCKS5h are currently supported. By default, if you specify SOCKS://<URL>, then SOCKS5h is applied.
--bus=eventBusUrl(Deprecated). Bright event bus URL.

Default: --bus amqps://