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

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

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

Select Open.
Log in to OX.
Note If your organization requires SSO, sign in using your enterprise email address.

The authorization completion message appears.

The authentication completion message appears.

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

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

Generate the IDE/CLI integration key.
In the Welcome to OX Security page, select Configure API Key. The Settings tab opens on the right.

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.