Skip to main content
Use the Vidoc CLI to scan your code for security vulnerabilities from your terminal.

​
Basic Scan

Navigate to your project directory and run: 
vidoc scan
Or simply: 
vidoc
The CLI indexes your code, scans for vulnerabilities, and syncs results with your Vidoc project.

​
Scan Options

​
Force Reindex

Force a complete reindex of the codebase (useful if files changed outside of git): 
vidoc scan --force-reindex
# or
vidoc scan -f

​
Index Only

Index the codebase without running a full scan: 
vidoc scan --only-indexing

​
Use a Specific Profile

Scan using a named profile: 
vidoc scan --profile work
# or
vidoc scan -p work

​
Override Token

Use a specific token for this scan: 
vidoc scan --token <your-token>

​
Custom API URL

For single-tenant installations: 
vidoc scan --api-url https://your-vidoc-instance.com

​
Custom Config File

Use a specific configuration file: 
vidoc scan --config /path/to/config
# or
vidoc scan -c /path/to/config

​
How Scanning Works

  1. Index - CLI analyzes your local files
  2. Upload - Code is sent to Vidoc for analysis
  3. Analyze - AI scans for security vulnerabilities
  4. Results - View findings in the Vidoc dashboard

​
Viewing Results

After scanning, view results in the Vidoc dashboard:
  1. Go to app.vidocsecurity.com
  2. Select your project
  3. Navigate to Issues to see findings

​
CI Mode

For CI/CD pipelines, use the dedicated ci command: 
vidoc ci
This runs in non-interactive mode optimized for automated environments. See CI/CD Integration for details.

​
Global Options

These options work with any command:
OptionShortDescription
--force-reindex-fForce complete reindex
--only-indexingIndex only, skip full scan
--profile <name>-pUse named profile
--api-url <url>Override API URL
--token <token>Override authentication token
--config <path>-cCustom config file path

​
Troubleshooting

​
”Not authenticated”

Run vidoc login to authenticate, or pass --token with your scan.

​
”No files found”

  1. Check you’re in the correct directory
  2. Ensure the directory contains supported file types
  3. Verify the project is properly initialized

​
Scan Taking Too Long

  1. Use --only-indexing first to see indexing progress
  2. Large codebases take longer on first scan
  3. Subsequent scans are faster (incremental indexing)

Installation

Install the CLI

Authentication

Configure tokens

CI/CD Integration

Automate in pipelines

Issues

Review scan results