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

Installing VibeSec On-Premises

Use this procedure to install VibeSec when your organization uses a self-hosted (on-premises) OX Security deployment.

Unlike SaaS deployments, on-premises deployments don't support OAuth authentication. Instead, VibeSec authenticates by using an OX API key.

What the installation script does

When you run the installation script, it:

  1. Downloads a standalone Node.js runtime into ~/.ox/node/. A system-wide Node.js installation isn't required.

  2. Downloads the VibeSec installation package from your on-premises OX platform.

  3. Installs the VibeSec hooks for the selected IDE.

  4. Registers the hooks in the IDE configuration.

  5. Stores the API key and the on-premises OX platform URL in ~/.<ide>/.ox.json.

Prerequisites

Before you begin, make sure you have the following:

Requirement
Description

OX platform URL

The URL of your on-premises OX deployment, for example https://ox.yourcompany.com.

OX account

An account with permission to generate API keys.

Network access

Access to your on-premises OX platform, nodejs.org, and ox-vibesec.s3.eu-west-1.amazonaws.com.

Step 1: Generate an API key

Step 2: Install VibeSec

Run the installation command for your operating system.

The installation script supports the following parameters:

Parameter
Description

<IDE>

The IDE to install VibeSec for. Supported values are claude, cursor, and copilot. Omit this parameter to install VibeSec for all supported IDEs.

<ONPREM_URL>

The URL of your on-premises OX deployment, for example https://ox.yourcompany.com.

<API_TOKEN>

The API key secret generated in Step 1.

Important: Verify that the --base-url parameter points to your on-premises OX platform. If the parameter is omitted or contains an invalid value, the installation script connects to the default OX SaaS environment instead.

macOS or Linux

Install VibeSec for a specific IDE.

Install VibeSec for all supported IDEs.

Windows (PowerShell)

Install VibeSec for a specific IDE.

Install VibeSec for all supported IDEs.

Uninstall VibeSec

macOS or Linux

Download the uninstallation script.

Remove VibeSec from all supported IDEs.

Remove VibeSec from a specific IDE.

Where <IDE> is one of the following:

  • claude

  • cursor

  • copilot

Windows (PowerShell)

Download the uninstallation script.

Remove VibeSec from all supported IDEs.

Remove VibeSec from a specific IDE.

Where <IDE> is one of the following:

  • claude

  • cursor

  • copilot

Last updated