Skip to main content
This guide walks you through setting up Vidoc and running your first security scan.

Prerequisites

  • A GitHub account with repositories to scan
  • Node.js 18+ (for CLI scanning)

Step 1: Create an Account

  1. Go to app.vidocsecurity.com
  2. Sign in with your GitHub account
  3. You’ll be redirected to your dashboard

Step 2: Create a Project

Projects group related repositories together. To create your first project:
  1. Click “New Project” in the dashboard
  2. Enter a project name (e.g., “My App”)
  3. Click “Create”

Step 3: Connect GitHub

Connect your GitHub account to enable automatic scanning:
  1. Go to SettingsIntegrations
  2. Click “Connect GitHub”
  3. Authorize Vidoc to access your repositories
  4. Select which repositories to scan
See GitHub Setup for detailed configuration options.

Step 4: Add a Repository

  1. Click “Add Repository” in your project
  2. Select a repository from the list
  3. Choose the default branch to scan

Step 5: Run Your First Scan

Once connected, Vidoc automatically scans:
  • New pull requests
  • Pushes to the default branch
Create a pull request to trigger your first scan.

Option B: CLI Scan

Install and run the CLI for immediate results:
# Install the CLI
npm i -g @vidocsecurity/cli

# Login with your API key
vidoc login

# Scan your code
vidoc scan
Get your API key from SettingsAPI Keys in the dashboard.

Step 6: Review Results

After the scan completes:
  1. Go to Issues in your project
  2. Review the security findings
  3. Click on an issue to see details:
    • Vulnerability description
    • Affected code snippet
    • Remediation guidance

Handling False Positives

If an issue is a false positive:
  1. Click “Ignore” on the issue
  2. Provide a reason (e.g., “Input is already sanitized”)
  3. Vidoc creates a learning to avoid similar false positives

Next Steps

Dashboard Overview

Learn to navigate the Vidoc dashboard

GitHub PR Comments

Configure PR feedback settings

CLI Scanning

Advanced CLI scanning options

Learnings

Teach Vidoc your codebase patterns