Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Using IZ Scan CLI

CI/CD Integration - Using IZ Scan CLI

Before scanning applications using IZ Scan, make sure you have:

  • Purchased a valid license for IZ Scan.

  • Downloaded and installed IZ Scan CLI plugin. Download the latest version of IZ Scan CLI from latest

  • Follow the instructions on Generating Security Token to generate a security token

  • The CLI downloaded prior to 26.3.1 will be in format falcon-scan-cli-<version>.zip . Rest of the parameters will remain the same

CI/CD Integration

  1. Once the appropriate version of IZ Scan CLI is downloaded, unzip the binary unzip iz-scan-cli-[VERSION]-[OS].zip

  2. Navigate to the bin directory within iz-scan-cli-[VERSION]-[OS]

  3. Run iz-scan-cli command with the following options

    1. -serviceHost=xxx IZ Scan service URL

    2. -authToken=xxx Security token generated from the server

    3. -applicationKey=x.x Unique ID of the application / project being scanned

    4. -applicationName=. Name of the application being scanned

    5. -source=xxx Optional. Location of the project source directory. If ignored, the current directory will be used as the project source directory

    6. -scmBranchName=xxx + Optional. SCM branch for which code is being analyzed. If ignored, the default value will be master

    7. -pullRequestId=xxx + _Optional.SCM Pull request name for which code is being analyzed

    8. -organization=xxx + Optional. Organization under which the project should be categorized. If ignored, the default organization will be used. Value can be any of Organization Name / Id / Ext Id

    9. -sarifReport=xxx + _Optional. Used to generate issues in SARIF format. The output report file path must be specified using this parameter.

  4. The complete example may look like 

    FALCON_SCAN_BIN_DIRECTORY> ./falcon-scan-cli -serviceHost -authToken -applicationKey orders-eapi -source <PROJECT_ROOT_DIRECTORY> -applicationName="Orders EAPI"

Setting Proxy Details

If the system from which the projects are analyzed is configured with a proxy, then set the following environment variable with the proxy server details -

  1. Windows

  2. Linux

  • Replace PROXY_HOST and PROXY_PORT with appropriate values for Proxy server host and port

  • If https.proxyPort is not specified default value will be 443

  • If http.proxyPort is not specified default value will be 80

See Also

PreviousUsing Maven
NextMule Coverage Reports

Last updated

Was this helpful?