- Checkmarx Documentation
- Checkmarx One
- Checkmarx One CLI Tool
- Checkmarx One CLI Commands
- help
help
The help command provides a help menu for every CLI command/Sub-command (Path for the command).
Usage
./cx help [command] [flags]
Available Commands
auth configure help project result scan utils version
Flags
- --help, -h
Help for the help command.
Examples
Using the help Command
ophir@OphirS-Laptop:~/ast-cli$ ./cx --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
chat: Interact with OpenAI models
completion: Generate the autocompletion script for the specified shell
configure: Configure authentication and global properties
help: Help about any command
project: Manage projects
results: Retrieve results
scan: Manage scans
triage: Manage results
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
--retry uint Retry requests to Checkmarx One on connection failure (default 3)
--retry-delay uint Time between retries in seconds, use with --retry (default 20)
--tenant string Checkmarx tenant
--timeout string Timeout for network activity, (default 5 seconds)
EXAMPLES
$ cx configure
$ cx scan create -s . --project-name my_project_name
$ cx scan list
DOCUMENTATION
https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html
QUICK START GUIDE
https://checkmarx.com/resource/documents/en/34965-68621-checkmarx-one-cli-quick-start-guide.html
LEARN MORE
Use 'cx <command> <subcommand> --help' for more information about a command.
Read the manual at https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.htmlcx.
Using the --help flag for the project command
ophir@OphirS-Laptop:~/ast-cli$ ./cx project --help The project command enables the ability to manage projects in Checkmarx One. USAGE cx project [flags] COMMANDS create: Creates a new project delete: Delete a project list: List all projects in the system show: Show information about a project tags: Get a list of all available tags FLAGS -h, --help help for project ead the manual at https://checkmarx.atlassian.net/wiki/x/MYDCkQ
Using the --help command for the project create sub-command
ophir@OphirS-Laptop:~/ast-cli$ ./cx project create --help
The project create command enables the ability to create a new project in Checkmarx One.
USAGE
cx project create [flags]
FLAGS
--branch string Main branch
--format string Format for the output. One of [json list table] (default "table")
--groups string List of groups, ex: (PowerUsers,etc)
-h, --help help for create
--project-name string Name of project
--tags string List of tags, ex: (tagA,tagB:val,etc)
GLOBAL 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
--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
--retry uint Retry requests to Checkmarx One on connection failure (default 3)
--retry-delay uint Time between retries in seconds, use with --retry (default 20)
--tenant string Checkmarx tenant
--timeout string Timeout for network activity, (default 5 seconds)
DOCUMENTATION
https://checkmarx.com/resource/documents/en/34965-68634-project.html
QUICK START GUIDE
https://checkmarx.com/resource/documents/en/34965-68621-checkmarx-one-cli-quick-start-guide.html
LEARN MORE
Use 'cx <command> <subcommand> --help' for more information about a command.
Read the manual at https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html
In this section: