CLI Setup Guide

Manage your Velaro account from the command line

The Velaro CLI lets you manage your knowledge base, bots, search indexes, workflows, and reporting without logging into the admin UI — useful for scripting, CI pipelines, and bulk changes.

Install

No install needed if you have Node.js 18+ — just run it with npx:

npx @velaro/cli login

If you use the CLI often, install it globally so you can drop the npx @velaro/:

npm install -g @velaro/cli
velaro login

Log in

velaro login

This opens a browser window to authenticate and saves your credentials locally. Check anytime with:

velaro whoami

Switch between staging and production (if you have access to both):

velaro env prod
velaro env staging

Common commands

velaro kb article list                  # list knowledge base articles
velaro kb article push my-article.md    # create or update an article from Markdown
velaro bot                              # manage AI bots
velaro index                            # search index status and reingest
velaro ingest                           # trigger ingestion for a completed scraper job
velaro workflow                         # manage automation workflows
velaro report                           # analytics: calls, service level, conversations
velaro site                             # site overview: features and agent availability
velaro activity                         # integration activity logs

Every command supports --help for its full option list, e.g. velaro kb article --help. Run velaro --help to see everything available to your account — the exact list depends on your subscription and role.

Update

velaro update

Or, if you installed globally: npm install -g @velaro/cli again to get the latest version.

Log out

velaro logout

Clears your saved credentials from this machine.

Troubleshooting

"Invalid key" / 401 — run velaro logout then velaro login again to refresh your session.

Command not found — if you installed globally and velaro isn't recognized, confirm npm's global bin directory is on your PATH, or just use npx @velaro/cli <command> instead.

Wrong site's data showing up — run velaro whoami to confirm which site you're logged into. Log out and back in to switch accounts.