Skip to content

CLI

The vercatus command talks to the same API the workspace uses, authenticated with an API key. It runs on any machine with Node.js 20 or later and never needs access to Vercatus’s own infrastructure. The API is the stable surface it wraps.

The command-line client is provided on request: ask at hello@vercatus.com and you are told how to install it. With it installed:

Terminal window
export VERCATUS_API_KEY=ca_… # Settings, API & webhooks
export VERCATUS_API_URL=https://app.vercatus.com

The package also carries vercatus-mcp, the MCP server over stdio.

Command What it does
vercatus sites Sites in the workspace and each one’s run allowance this period
vercatus add <url> Add a site and print the DNS record or meta tag that verifies it
vercatus verify <host> [--search-console] Check the record and mark the site verified; with --search-console, check the site’s connected Search Console instead
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 site audit findings across the latest run of every site
vercatus report <runId> [-o file] Save the standalone HTML report
vercatus usage What this period has used of the plan
vercatus check-preview <previewUrl> --site <id> [--paths list|git:<base>] Compare a preview deploy with production as answer engines’ crawlers read it; see the pull-request citability check

A run started from the CLI counts against the site’s 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