Command List
The Bright CLI accepts a wide variety of configuration options. You can run bright-cli --help
command for comprehensive documentation. The configuration options and arguments in the command line must be passed after the program command that the Bright CLI is executing.
bright-cli <command> [option] [<argument>]
- Most commands and some options have aliases. Aliases are shown in the syntax statement for each command.
- The option names are prefixed with a double dash (--). The option aliases are prefixed with a single dash (-). Arguments are not prefixed.
- Support is provided for an array of options of a specific command, separated by a space. For example:
bright-cli scan:run --token API_KEY --name SCAN_NAME --crawler TARGET_URL --param path query body --test default_login_location dom_xss sqli
The Bright CLI provides the following global options that can affect the behavior of each command:
Option | Description |
---|---|
| The token (API key) to use, either a User Key, a Project Key or an Organization Key. Required option. |
| Specifies a Repeater ID that should be used for this operation. |
| Specifies the path to the configuration file. By default, the CLI tries to discover the config in package.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. |
| 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, 5, "silent", "error", "warn", "notice", "verbose", "trace". Default: 3 |
| Allows the Bright CLI to proceed and operate even if the server connection is considered insecure. Default: |
| Bright cluster (domain name). Default: |
| Specify a proxy URL to route all traffic through. This should be an HTTP(S), SOCKS4, or SOCKS5 URL. Default: If you specify |
| Specify a proxy URL to route the traffic to Bright. |
| Specify a proxy URL to route the traffic to the targets. |
| The optional flag that can be used with either Domains can include wildcards. For example, Note: Traffic that goes to Bright will always be proxied if |
| Space-separated list of domains that should not be routed through the proxy. This option is only applicable when using the --proxy option. Example: (Cannot be used with --proxy-domains at the same time) |
| The optional flag allows users to set a timeout in seconds or a duration string (e.g.: 10s, 1m). Default: 30 seconds. |
| File path to write logs to. If specified, logs will be written to this file Default: User home directory Extra optional params when
|
| Shows the Bright CLI version. |
| Shows the Bright CLI help documentation. |
Updated 1 day ago