Skip to main content

Global Flags

The CLI tool supports a set of global flags.

The Global flags are optional for every CLI command/Sub-command.

The below table includes all the global flags that can be added to the CLI commands.

Flag

Default

Description

--agent <string>

ASTCLI

Scan origin name

--apikey <string>

The API Key to login to Checkmarx One with

--base-auth-uri <string>

The Checkmarx One User Management URI

--base-uri <string>

The Checkmarx One server URI

--client-id <string>

The oAuth2 client ID

--client-secret <string>

The oAuth2 client secret

--help, -h

Help for every cx command/sub-command

--insecure

Ignore TLS certificate validations

--profile <string>

default

The default configuration profile

--proxy <string>

Proxy server to send communication through

--proxy-auth-type <string>

Proxy authentication type, (basic or ntlm)

--proxy-ntlm-domain <string>

Window domain when using NTLM proxy

--tenant <string>

organization

The tenant name of the Checkmarx One Server

--timeout <string>

5 Seconds

Timeout for network activity

--retry <uint>

3 times

Retry requests to Checkmarx One on connection failure

--retry-delay <uint>

3 seconds

Time between retries in seconds, use with --retry

--debug

Debug mode with detailed logs

For example:

[email protected]:/ast$ ./cx.exe --help
The Checkmarx One CLI is a fully functional Command Line Interface (CLI) that interacts with the Checkmarx One server.

USAGE
  cx <command> <subcommand> [flags]

COMMANDS
  auth:       Validate authentication and create OAuth2 credentials
  configure:  Configure authentication and global properties
  help:       Help about any command
  project:    Manage projects
  result:     Retrieve results
  scan:       Manage scans
  utils:      Utility functions
  version:    Prints the version number

FLAGS
      --agent string               Scan origin name (default "ASTCLI")
      --apikey string              The API Key to login to Checkmarx One
      --base-auth-uri string       The base system IAM URI
      --base-uri string            The base system URI
      --client-id string           The OAuth2 client ID
      --client-secret string       The OAuth2 client secret
      --debug                      Debug mode with detailed logs
  -h, --help                       help for cx
      --insecure                   Ignore TLS certificate validations
      --profile string             The default configuration profile (default "default")
      --proxy string               Proxy server to send communication through
      --proxy-auth-type string     Proxy authentication type, (basic or ntlm)
      --proxy-ntlm-domain string   Window domain when using NTLM proxy
      --tenant string              Checkmarx tenant

EXAMPLES
  $ cx configure
  $ cx scan create -s . --project-name my_project_name
  $ cx scan list

DOCUMENTATION
  https://checkmarx.atlassian.net/wiki/x/MYDCkQ

QUICK START GUIDE
  https://checkmarx.atlassian.net/wiki/x/mIKctw

ENVIRONMENT VARIABLES
  See 'cx utils env' for  the list of supported environment variables.

LEARN MORE
  Use 'cx <command> <subcommand> --help' for more information about a command.
  Read the manual at https://checkmarx.atlassian.net/wiki/x/MYDCkQ