# Installing the OX IDE Extension

You can install the OX IDE Extension from your IDE marketplace, as follows:

* **VS Code Marketplace:** <https://marketplace.visualstudio.com/items?itemName=oxsecurity.ox-ide>
* **Open VSX Marketplace:** <https://open-vsx.org/extension/oxsecurity/ox-ide>

> **Note:** If your environment blocks marketplace access, for example, offline or restricted networks, contact OX technical support.

## Requirements

* Visual Studio Code ^1.96.0
* Git extension for VS Code
* An OX.security account with API access

## **Step 1: Start the IDE extension installation**

1. In **Marketplace**, search for **OX Security**.

<figure><img src="/files/klR9CY1cW1BCzqrJn3JW" alt="" width="563"><figcaption></figcaption></figure>

2. Select **Install**. The OX icon appears in the left bar, and a welcome page appears.

<figure><img src="/files/fmnAT99ZzIa855oUGiFa" alt="" width="375"><figcaption></figcaption></figure>

3. To login with OAuth, continue to [Login using OAuth](#step-2-login-using-oauth)
4. To login with token, [Generate the IDE/CLI integration key](/scan-and-analyze-with-ox/scanning/ox-ide-integrations/generating-ide-cli-integration-key.md).

## **Step 2: Login using OAuth**

1. In the **Welcome to OX Security** page, select **Login via OAuth (OX account required)**.

<figure><img src="/files/XcqhorWC5J8LgRPTDvF9" alt="" width="563"><figcaption></figcaption></figure>

2. Select **Open**.
3. Log in to OX.

   > **Note**\
   > If your organization requires SSO, sign in using your enterprise email address.

<figure><img src="/files/0iOX7Ku2rgsrjgsMdzy6" alt="" width="563"><figcaption></figcaption></figure>

The authorization completion message appears.

<figure><img src="/files/iGBOdvHaOu2hec0XgvaE" alt="" width="563"><figcaption></figcaption></figure>

The authentication completion message appears.

<figure><img src="/files/SCNS70LWfy0vGBn9Orlg" alt="" width="563"><figcaption></figcaption></figure>

The message **No issues detected yet** appears on the left and the OX icon appears on the side bar.

<figure><img src="/files/9rbhORsb1EOifaFEvTQT" alt="" width="563"><figcaption></figcaption></figure>

The following commands are now available from the side bar:

|                         |                                                               |
| ----------------------- | ------------------------------------------------------------- |
| `Open Settings`         | Opens the OX extension settings panel.                        |
| `Report an Issue`       | Opens a template to report bugs to the OX GitHub repository.  |
| `Upload Logs`           | Sends logs to telemetry.                                      |
| `Focus on Found Issues` | Highlights issues in the sidebar.                             |
| `Sign out`              | Sign out of the OX IDE extension and clear the authentication |

## Step 3: Login using token

1. [Generate the IDE/CLI integration key](/scan-and-analyze-with-ox/scanning/ox-ide-integrations/generating-ide-cli-integration-key.md).
2. In the **Welcome to OX Security** page, select **Configure API Key**. The **Settings** tab opens on the right.

<figure><img src="/files/IXrrqLpj7lQbUkVqDHgz" alt="" width="563"><figcaption></figcaption></figure>

3. Add the API key that you generated in the OX Security platform. The message **No issues detected yet** appears on the left and the OX icon appears on the side bar.

<figure><img src="/files/9rbhORsb1EOifaFEvTQT" alt="" width="563"><figcaption></figcaption></figure>

The following commands are now available from the side bar:

|                         |                                                              |
| ----------------------- | ------------------------------------------------------------ |
| `Open Settings`         | Opens the OX extension settings panel.                       |
| `Report an Issue`       | Opens a template to report bugs to the OX GitHub repository. |
| `Upload Logs`           | Sends logs to telemetry.                                     |
| `Focus on Found Issues` | Highlights issues in the sidebar.                            |


---

# Agent Instructions: 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:

```
GET https://docs.ox.security/scan-and-analyze-with-ox/scanning/ox-ide-integrations/ox-ide-extension/installing-the-ox-ide-extension.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.