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

Installing VibeSec on a Single Device Using API Token

This guide explains how to install and connect VibeSec to AI-powered coding environments using token authentication.

Once the connection is established, VibeSec activates automatically in your development environment and applies security controls during coding, without interrupting your workflow.

After the installation, your admin can view developer usage and risk-prevention metrics in the VibeSec Usage Report in the OX dashboard.

You can uninstall VibeSec at any time.

Note: When using Copilot, the following models are not supported with the VS Code Copilot Extension: Gemini 2.5 Pro and GPT-4o. You can disable them before you start working with OX VibeSec. For instructions on how to disable Copilot models, refer to Disabling Unsupported Copilot Models.

If installation completes but no activity appears in the VibeSec dashboard, see Troubleshooting VibeSec Installation.

Prerequisites

Prerequisite
Details

Network access

If your organization restricts outbound network traffic (for example, using a proxy or firewall), add the following domains to your allowlist: api.cloud.ox.security* ox-vibesec.s3.eu-west-1.amazonaws.com*

TLS inspection and HTTPS proxies

If your organization inspects outbound HTTPS traffic using TLS inspection, an HTTPS proxy, or a SASE/CASB endpoint agent, add the CA certificate used to re-sign the traffic to the trust store of every machine where VibeSec is installed. VibeSec uses the machine trust store, so no additional VibeSec configuration is required.

If the CA certificate is not trusted, VibeSec installation may appear to succeed, but VibeSec activity does not reach the OX platform. For more information, see Troubleshooting VibeSec installation.

VibeSec token

Create a new VibeSec token before you begin.

Install VibeSec on Cursor, Claude Code, Kiro, VS Code IDE Extension, and VS Code Copilot Extension

  1. From any terminal, run:

Mac

curl -fsSL https://ox-vibesec.s3.eu-west-1.amazonaws.com/vibesec-installation/install.sh | bash -s -- --ox-flag --token "${OX_TOKEN}"

When using a proxy, add:

Linux

When using a proxy, add:

Windows (PowerShell)

When using a proxy, add:

  1. Restart your AI coding tool.

Note It is recommended to test VibeSec with a prompt such as:

Create a web form that accepts user input and stores it in the database,

or

Create a web form that allows the user to upload a file and store it in the database.

Use a custom user identity

By default, VibeSec automatically determines the user identity that appears in the Agent Activity Log. If needed, you can specify a custom identity during installation by using the optional --user parameter (-User on Windows).

This option is useful when:

  • You use VibeSec outside a Git repository and no Git user email is available.

  • You deploy VibeSec through an MDM solution and want activity to be associated with a predefined device or user identifier.

  • You want to report activity under a custom name instead of the Git user email.

Linux and macOS

Windows

The value can be any text and does not need to be an email address.

The --user parameter is supported only for API token installations. When you install VibeSec by using OAuth authentication, the installer ignores this parameter because the user identity is obtained from the authenticated OAuth session.

If you don't specify --user, VibeSec determines the identity by using the following order:

  1. The Git user.email value.

  2. The operating system user, formatted as username@hostname.

  3. An automatically generated anonymous identifier.

The resolved identity is displayed in the Agent Activity Log.

Last updated