Skip to content
Vercatus

CLI

The vercatus command talks to the same API the workspace uses, authenticated with an API key. It runs on any machine and never needs access to Vercatus’s own infrastructure.

Terminal window
npm install -g @vercatus/cli
export VERCATUS_API_KEY=ca_…          # Settings → API keys
export VERCATUS_API_URL=https://app.vercatus.com
Command What it does
vercatus sites Sites in the workspace and each one’s run allowance this month
vercatus add <url> Add a site and print the DNS record or meta tag that verifies it
vercatus verify <host> Check the record and mark the site verified
vercatus estimate <url> [-n pages] [--light] What a run of this size consumes — allowance, requests, crawl time — before starting it
vercatus run <url> [-n pages] [--light] [--no-render] [--no-agents] [--wait] Start a run; --wait prints each step until it finishes
vercatus runs [--site host] Recent runs
vercatus status <runId> One run: every step with progress, and the headline numbers
vercatus findings [--site host] [--severity s] Open findings across the latest run of every site
vercatus report <runId> [-o file] Save the standalone HTML report
vercatus usage What this month has used of the plan

A run started from the CLI counts against the site’s monthly allowance exactly as one started from the workspace does. Exit status is non-zero on any API error, so the command is safe to use in a pipeline:

Terminal window
vercatus run https://example.com/sitemap.xml --light --wait && vercatus findings --severity critical

Operators running their own instance have a second command, ca, described under Running your own instance.