Install
01 / 10

One package, no daemon

The CLI is a small Node binary — install it globally and it talks straight to the API. Nothing runs in the background.

Requirements

  • Node.js 18+
    Why
    The CLI uses built-in fetch — no extra dependencies at runtime
  • A Vectr API key
    Why
    Only for vectr agent — tokens and price work keyless

From source — works today

git clone https://git.vectr.bot/vectr/cli.git vectr-cli
cd vectr-cli && pnpm install && pnpm build
npm link

Source builds are how you audit what runs — the CLI is a thin HTTP client over the same public API the site uses, so there is nothing to trust beyond the endpoints themselves.

Package managers — once published

npm i -g @vectr/cli
pnpm add -g @vectr/cli
yarn global add @vectr/cli

The @vectr/cli package publishes at launch — until then, the source build is the install. It puts the same vectr binary on your PATH.

Verify

vectr --version
vectr price

vectr price is a good smoke test — it's keyless, so a working reply proves the network path before you've configured anything.

Upgrading and removing

npm update -g @vectr/cli   # once published — source builds: git pull && pnpm build
npm rm -g @vectr/cli       # uninstall — credentials stay in ~/.vectr

Uninstalling keeps your key

The binary and the credentials are separate — removing the package leaves ~/.vectr/config.json behind. Delete that too if you're rotating keys.