> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vidocsecurity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Installation

> Install the Vidoc CLI for local and CI/CD scanning

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 (Recommended)

```bash theme={null}
npm i -g @vidocsecurity/cli
```

### yarn

```bash theme={null}
yarn global add @vidocsecurity/cli
```

### npx (No Installation)

Run without installing:

```bash theme={null}
npx @vidocsecurity/cli scan
```

## Verify Installation

Check that the CLI is installed:

```bash theme={null}
vidoc version
```

## Update

Update to the latest version:

```bash theme={null}
npm update -g @vidocsecurity/cli
```

## Uninstall

Remove the CLI:

```bash theme={null}
npm uninstall -g @vidocsecurity/cli
```

## Troubleshooting

### "command not found: vidoc"

Ensure the npm global bin directory is in your PATH:

```bash theme={null}
# 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:

```bash theme={null}
# 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

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/cli/authentication">
    Login with your API token
  </Card>

  <Card title="Scanning" icon="magnifying-glass" href="/cli/scanning">
    Run your first scan
  </Card>
</CardGroup>