Skip to main content
The Vidoc CLI scans your codebase for security vulnerabilities from your terminal or CI/CD pipelines.

​
Requirements

  • Node.js 18 or higher
  • npm or yarn package manager

​
Installation

npm i -g @vidocsecurity/cli

​
yarn

yarn global add @vidocsecurity/cli

​
npx (No Installation)

Run without installing: 
npx @vidocsecurity/cli scan

​
Verify Installation

Check that the CLI is installed: 
vidoc version

​
Update

Update to the latest version: 
npm update -g @vidocsecurity/cli

​
Uninstall

Remove the CLI: 
npm uninstall -g @vidocsecurity/cli

​
Troubleshooting

​
”command not found: vidoc”

Ensure the npm global bin directory is in your PATH: 
# Find npm global bin directory
npm config get prefix

# Add to your shell profile (.bashrc, .zshrc, etc.)
export PATH="$(npm config get prefix)/bin:$PATH"

​
Permission Errors

If you get permission errors during installation: 
# Option 1: Fix npm permissions (recommended)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

# Option 2: Use sudo (not recommended)
sudo npm i -g @vidocsecurity/cli

​
Next Steps

Authentication

Login with your API token

Scanning

Run your first scan