VibeCodeXray
Sign InGet Started
Back

Documentation

Learn how to integrate VCX into your workflow.

Quick Start

1. Install the CLI

terminal
$ npm install -g @vcx/cli

2. Authenticate

terminal
$ vcx auth login

Opens your browser to authenticate with your VCX account.

3. Scan a project

terminal
$ vcx scan ./my-project

Scans the directory and outputs results to your terminal. Add --json for machine-readable output.

GitHub Integration

CI/CD integration is coming soon. You'll be able to add VCX to your pipeline to scan every pull request automatically.

GitHub Actions workflow example coming soon.

In the meantime, use the CLI: npx vibecodexray scan

API Reference

Base URL: https://api.vcx.dev

MethodEndpointDescription
POST/v1/scanSubmit a repository for scanning
GET/v1/scan/{id}Get scan results by ID
GET/v1/scan/{id}/issuesList issues from a scan
GET/v1/usageGet current usage and limits

Authentication

All API requests require authentication via Bearer token.

Get your API key

Go to Dashboard → Settings → API Keys to generate a token.

request header
Authorization: Bearer vcx_sk_...