Running a Scan

--token=apiKey, -t=apiKey

The unique identifier used to authenticate a user. The token (API key) can be issued in your organization’s dashboard.

--name=scanName, -n=scanName

The name of the scan

--archive=fileId, -a=fileId

The archive ID, which can be received via the archive:upload command.

--crawler=url, -c=url

Specifies a list of specific URLs that should be included during crawler discovery.

--repeater=repeaterId,
--agent=repeaterId (Deprecated)

Specifies a list of Repeater UUIDs that should be connected with the scan

--cluster

Bright cluster (domain name)

• *Default:** app.brightsec.com

--project, -p

Allows specifying the Bright project for a scan using the project ID. You can find the project ID in the Projects section in the Bright app.

--integration, -i

Allows connecting a ticketing service with an associated repository for a scan. It enables you to get the reports on every detected vulnerability in automatically opened tickets/issues of the associated repository.

• *Note:** You can only connect a ticketing service (system) that was previously integrated with the Bright app. Read more about integrating Bright with ticketing systems here.
• Format:_ -i "service:repository"
• Example:_ -i "github:example-app"
  If you want to connect several repositories for one scan, you can specify them one after another: -i "github:example-app" -i "jira:example-app"\

Important:

• To connect a ticketing service and a repository for a scan, the token (API key) that you use for the scan must include the integration.repos:read scope.
• The --integration (-i) parameter cannot be used without a valid --project (-p) parameter (see above). Make sure that you connect a repository associated with the specified project.

--smart

Enables you to use automatic smart decisions, such as parameter skipping, detection phases, and so on to minimize scan time. When set to false (turned off), all tests are run on all parameters, which increases the coverage at the expense of scan time.

• *Default**: --smart true

--param=path/query/fragment/
header/body/artifical-fragment/artifical-query

Defines which part of the request to attack.

• *Note:** This argument can be passed multiple times in the same command.
• *Default:** --parameter body query fragment.

--host-filter=hostOrIp, -F=hostOrIp

The list of specific hosts to be included in the scan.

--header=headerName:headerValue,
-H=headerName:headerValue

Extra headers to be passed with the archive file. It can also be used to remove a header by providing a name without content. For example, -H "Host:".

• *Warning:** Headers set with this option override the archive headers and are set in all the requests.

--test=testName

Specifies a list of relevant tests to execute during a scan.
For example, --test default_login_location dom_xss.

--auth=authObjectID,
-o=authObjectID

Specifies the ID of the authentication object to be connect to the scan. Find more info about using an authentication object at Manging Your Authentications.

--config=pathToConfig

Specifies the path to the configuration file. By default, the CLI tries to discover the config in thepackage.json in the root directory of your application or a separate file by a specified name in the working directory. For details, see Configuration Files for more information.

--log-level=0/1/2/3/4/silent/
error/warn/notice/verbose

Allows setting the level of logs to report. Any logs of a higher level than the one specified are shown. The options to select : 0, 1, 2, 3, 4, "silent", "error", "warn", "notice", "verbose".

• *Default:** 3

--insecure

Allows the Bright CLI to proceed and operate even if the server connection is considered insecure.

--proxy=socksProxyUrl

SOCKS URL to proxy all traffic.

• *Note:** SOCKS4, SOCKS5, SOCKS4a, SOCKS5h are currently supported. By default, if you specify SOCKS://<URL>, then SOCKS5h is applied.

--api=clusterUrl

• *(Deprecated)**. Set the API endpoint domain, for VPC, use: --api https://private-domain.brightsec.com
• *Default:** --api <https://app.brightsec.com>

--exclude

Enables you to manage exclusions from a scan.

If you want to ignore some of the parameter names during the tests, use exclude-param. For example, --exclude-param ID$.

--exclude-entry-point A list of JSON strings that contain patterns for entry points you would like to ignore during the tests.

Important:

• To remove default exclusions, pass an empty string.
• To apply patterns for all HTTP methods, you can set an empty array to “methods”. For example {“methods”: [], “patterns”: “users\\/?$”}.