# OX IDE Plugin (JetBrains)

The OX IDE plugin provides scanning of code changes locally within JetBrains IDEs.

It integrates with the OX Security platform and is intended for developers working in JetBrains environments such as IntelliJ IDEA, PyCharm, and WebStorm.

The plugin is installed through the IDE plugin system and is accessed through the IDE interface, where you can configure settings, run scans, and review issues directly in your code.

After a scan completes, the plugin displays the detected issues in the IDE.

Each issue is linked to the exact line of code and includes relevant details and remediation recommendations.

### Supported IDEs

The plugin supports JetBrains IDEs, including:

* IntelliJ IDEA
* PyCharm
* WebStorm
* GoLand
* PhpStorm

Additional JetBrains IDEs are also supported.

### Requirements

* A JetBrains IDE
* An OX Security account with API access

Before you install the plugin, generate an API key.

## Installing the OX IDE Plugin

You can install the OX IDE plugin from your IDE marketplace.

**To install the plugin:**

1. [Generate the IDE/CLI integration key.](https://docs.ox.security/scan-and-analyze-with-ox/scanning/ox-ide-integrations/generating-ide-cli-integration-key)
2. In your IDE, go to **Settings**.
3. Select **Plugins**.
4. Open the **Marketplace** tab.
5. Search for **OX Security**.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-c46bacd96f7bb38be268228d3b1ce7f32bb16dca%2F1.marketplace_installation.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

6. Select **Install**.
7. Click **Apply**, then **OK**.
8. Restart the IDE if prompted.

After installation, the plugin appears in the IDE.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-2910a80656efc5447dac9d898acd2655023c0065%2F2.%20plugin%20installed.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

### Alternative: Manual installation

If the marketplace is not available, install the plugin manually:

1. Go to **Settings**.
2. Select **Plugins**.
3. Click **⚙ > Install Plugin from Disk**.
4. Select the plugin `.zip` file.
5. Click **Apply**, then restart the IDE.

### Configuring the plugin

After installation, you can configure the plugin.

**To configure the plugin:**

1. Go to **Tools > OX Security**.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-956330da41b1f156d513d42c813f2ae9c466306a%2F3.%20configure%20plugin%20%20settings%20(1).png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

2. Enter the API key that you generated.
3. (Optional) Configure additional settings such as endpoint or telemetry.
4. Click **Apply**, then **OK**.

### Running a scan and analyzing the results

After installing the plugin and setting it up, you can start running security scans.

**To run a scan:**

* Click the scan button in the plugin.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-6a6b195deadf3eab71bb71c5183239edb174a7c8%2F4.%20click%20buttom%20to%20initiate%20a%20scan.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

The scan runs, and the results appear in the IDE.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-28f3b9d5223e199f4c64164aa9864933fa5b2505%2F5.%20scan%20finished.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

Each issue includes:

* Severity label
* Short description
* Category
* Reference to the affected code line
* Suggested fix

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-ed093d0cd1b02d4ef67f99c33bdd7ef2d7d419e2%2F6.%20issue%20details.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

Now you can review issues directly in the code and navigate to the relevant lines.