|
| 1 | +The create command enables the ability to create and run a new scan in Checkmarx One |
| 2 | + |
| 3 | +USAGE |
| 4 | + cx scan create [flags] |
| 5 | + |
| 6 | +FLAGS |
| 7 | + --apisec-swagger-filter string Swagger folder/file filter for API-Security scan. Example: ./swagger.json |
| 8 | + --application-name string Name of the application to assign with the project |
| 9 | + --async Do not wait for scan completion |
| 10 | + -b, --branch string Branch to scan |
| 11 | + --branch-primary This flag sets the branch specified in --branch as the PRIMARY branch for the project |
| 12 | + --container-images string List of container images to scan, ex: manuelbcd/vulnapp:latest,debian:10 |
| 13 | + --containers-exclude-non-final-stages Scan only the final deployable image |
| 14 | + --containers-file-folder-filter string Specify files and folders to be included or excluded from scans, ex: "!*.log" |
| 15 | + --containers-image-tag-filter string Exclude images by image name and/or tag, ex: "*dev" |
| 16 | + --containers-local-resolution Execute container resolver locally. |
| 17 | + --containers-package-filter string Exclude packages by package name or file path using regex, ex: "^internal-.*" |
| 18 | + -f, --file-filter string Source file filtering pattern |
| 19 | + -i, --file-include string Only files scannable by AST are included by default. Add a comma separated list of extra inclusions, ex: *zip,file.txt |
| 20 | + -s, --file-source string Sources like: directory, zip file or git URL |
| 21 | + --filter strings Filter the list of results. Use ';' as the delimiter for arrays. Available filters are: scan-id,limit,offset,sort,include-nodes,node-ids,query,group,status,severity,state |
| 22 | + -h, --help help for create |
| 23 | + --iac-security-filter string IaC Security filter |
| 24 | + --iac-security-platforms strings IaC Security Platform Flag |
| 25 | + --iac-security-preset-id string The ID of the IaC Security Preset to use (must be a valid UUID) |
| 26 | + --ignore-policy Skip policy evaluation. Requires override-policy-management permission. |
| 27 | + --output-name string Output file (default "cx_result") |
| 28 | + --output-path string Output Path (default ".") |
| 29 | + --policy-timeout int Cancel the policy evaluation and fail after the timeout in minutes (default 4) |
| 30 | + --project-groups string List of groups to associate to project |
| 31 | + --project-name string Name of the project |
| 32 | + --project-private-package string Enable or disable project private package. Available options: true,false |
| 33 | + --project-tags string List of tags to associate to project |
| 34 | + --report-format string Format for the output. One of [json json-v2 summaryHTML sarif sbom pdf markdown gl-sast gl-sca summaryConsole] (default "summaryConsole") |
| 35 | + --report-pdf-email string Send the PDF report to the specified email address. Use "," as the delimiter for multiple emails |
| 36 | + --report-pdf-options string Sections to generate PDF report. Available options: Iac-Security,Sast,Sca,ScanSummary,ExecutiveSummary,ScanResults (default "ScanSummary,ExecutiveSummary,ScanResults") |
| 37 | + --report-sbom-format string Sections to generate SBOM report. Available options: CycloneDxJson,CycloneDxXml,SpdxJson (default "CycloneDxJson") |
| 38 | + --resubmit Create a scan with the configurations used in the most recent scan in the project |
| 39 | + --sast-fast-scan Enable SAST Fast Scan configuration |
| 40 | + --sast-filter string SAST filter |
| 41 | + --sast-incremental Incremental SAST scan should be performed. |
| 42 | + --sast-light-queries Enable SAST scan using light query configuration |
| 43 | + --sast-preset-name string The name of the Checkmarx preset to use. |
| 44 | + --sast-recommended-exclusions Enable recommended exclusions configuration for SAST scan |
| 45 | + --sast-redundancy Populate SAST results 'data.redundancy' with values 'fix' (to fix) or 'redundant' (no need to fix) |
| 46 | + --sbom-only Scan only the specified SBOM file (supported formats xml or json) |
| 47 | + --sca-exploitable-path string Enable or disable exploitable path in scan. Available options: true,false |
| 48 | + --sca-filter string SCA filter |
| 49 | + --sca-hide-dev-test-dependencies Filter SCA results to exclude dev and test dependencies |
| 50 | + --sca-last-sast-scan-time string SCA last scan time. Available options: integer above 1 |
| 51 | + --sca-private-package-version string SCA project private package version. Example: 0.1.1 |
| 52 | + --sca-resolver string Resolve SCA project dependencies (path to SCA Resolver executable) |
| 53 | + --sca-resolver-params string Parameters to use in SCA resolver (requires --sca-resolver) |
| 54 | + --scan-info-format string Format for the output. One of [table json list] (default "list") |
| 55 | + --scan-timeout int Cancel the scan and fail after the timeout in minutes |
| 56 | + --scan-types string Scan types, ex: (sast,iac-security,sca,api-security) |
| 57 | + --scs-engines string Specify which scs engines will run (default: all licensed engines) |
| 58 | + --scs-repo-token string Provide a token with read permission for the repo that you are scanning (for scorecard scans) |
| 59 | + --scs-repo-url string The URL of the repo that you are scanning with scs (for scorecard scans) |
| 60 | + --ssh-key string Path to ssh private key |
| 61 | + --tags string List of tags, ex: (tagA,tagB:val,etc) |
| 62 | + --threshold string Local build threshold. Format <engine>-<severity>=<limit>. Example: scan --threshold "sast-high=10;sca-high=5;iac-security-low=10" |
| 63 | + --use-gitignore Exclude files and directories from the scan based on the patterns defined in the directory's .gitignore file |
| 64 | + --wait-delay int Polling wait time in seconds (default 5) |
| 65 | + |
| 66 | +GLOBAL FLAGS |
| 67 | + --agent string Scan origin name (default "ASTCLI") |
| 68 | + --apikey string The API Key to login to Checkmarx One |
| 69 | + --base-auth-uri string The base system IAM URI |
| 70 | + --base-uri string The base system URI |
| 71 | + --client-id string The OAuth2 client ID |
| 72 | + --client-secret string The OAuth2 client secret |
| 73 | + --config-file-path string Path to the configuration file |
| 74 | + --debug Debug mode with detailed logs |
| 75 | + --ignore-proxy Ignore proxy configuration |
| 76 | + --insecure Ignore TLS certificate validations |
| 77 | + --log-file string Saves logs to the specified file path only |
| 78 | + --log-file-console string Saves logs to the specified file path as well as to the console |
| 79 | + --proxy string Proxy server to send communication through |
| 80 | + --proxy-auth-type string Proxy authentication type (supported types: basic, ntlm, kerberos or kerberos-native) |
| 81 | + --proxy-kerberos-ccache string Path to Kerberos credential cache (optional, default uses KRB5CCNAME env or OS default) |
| 82 | + --proxy-kerberos-krb5-conf string Path to Kerberos configuration file(default: /etc/krb5.conf on linux and C:\Windows\krb5.ini on windows) |
| 83 | + --proxy-kerberos-spn string Service Principal Name (SPN) for Kerberos proxy authentication |
| 84 | + --proxy-ntlm-domain string Window domain when using NTLM proxy |
| 85 | + --retry uint Retry requests to Checkmarx One on connection failure (default 3) |
| 86 | + --retry-delay uint Time between retries in seconds, use with --retry (default 20) |
| 87 | + --tenant string Checkmarx tenant |
| 88 | + --timeout string Timeout for network activity, (default 5 seconds) |
| 89 | + |
| 90 | +EXAMPLES |
| 91 | + $ cx scan create --project-name <Project Name> -s <path or repository url> |
| 92 | + |
| 93 | +DOCUMENTATION |
| 94 | + https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-a0bb20d5-5182-3fb4-3da0-0e263344ffe7 |
| 95 | + |
| 96 | +QUICK START GUIDE |
| 97 | + https://checkmarx.com/resource/documents/en/34965-68621-checkmarx-one-cli-quick-start-guide.html |
| 98 | + |
| 99 | +LEARN MORE |
| 100 | + Use 'cx <command> <subcommand> --help' for more information about a command. |
| 101 | + Read the manual at https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html |
| 102 | + |
0 commit comments