> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/iz-scan/ci-cd-integration/using-iz-scan-cli.md).

# Using IZ Scan CLI

## CI/CD Integration - Using IZ Scan CLI

{% hint style="warning" %}
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](/product-guides/integral-zone/iz-suite/releases/iz-scan-cli/latest.md)
* Downloaded and installed JDK 11
* Follow the instructions on [Generating Security Token](/product-guides/integral-zone/iz-suite/iz-scan/ci-cd-integration/generate-security-token.md) to generate a security token
  {% endhint %}

### CICD 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\
      \&#xNAN;*IZ Scan service URL*
   2. -authToken=xxx\
      \&#xNAN;*Security token generated from the server*
   3. -applicationKey=x.x\
      \&#xNAN;*Unique ID of the application / project being scanned*
   4. -applicationName=.\
      \&#xNAN;*Name of the application being scanned*
   5. -source=xxx\
      \&#xNAN;*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&#x20;

   ```
   set JAVA_TOOL_OPTIONS="-Dhttps.proxyHost=PROXY_HOST -Dhttps.proxyPort=PROXY_PORT -Dhttp.proxyHost=PROXY_HOST -Dhttp.proxyPort=PROXY_PORT -Djava.net.useSystemProxies=true"
   ```
2. Linux&#x20;

   ```
   export JAVA_TOOL_OPTIONS="-Dhttps.proxyHost=PROXY_HOST -Dhttps.proxyPort=PROXY_PORT -Dhttp.proxyHost=PROXY_HOST -Dhttp.proxyPort=PROXY_PORT -Djava.net.useSystemProxies=true"
   ```

{% hint style="info" %}

* Replace **`PROXY_HOST`** and **`PROXY_PORT`** with appropriate values for Porxy 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
  {% endhint %}

### See Also

* [Mule Code Coverage](/product-guides/integral-zone/iz-suite/iz-scan/ci-cd-integration/mule-coverage-reports.md)
* [Install IZ Scan for Cloud](/product-guides/integral-zone/iz-suite/iz-scan/vs-code-extension/installation/cloud-version.md)
* [Install IZ Scan for Desktop](/product-guides/integral-zone/iz-suite/iz-scan/vs-code-extension/installation/desktop-version.md)
* [Aborting Builds](/product-guides/integral-zone/iz-suite/iz-scan/ci-cd-integration/terminate-build.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/iz-scan/ci-cd-integration/using-iz-scan-cli.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.