Install the CLI

Install from npm

npm install -g @useconvoy/cli
convoy --help

Or run on demand without installing:

npx @useconvoy/cli --help
npx @useconvoy/cli connect

macOS, Linux, and Windows all invoke it as convoy after a global install.

Updating

convoy connect checks npm on startup and prints a one-line notice when a newer version is published:

↑ Update available: 0.49.3 → 0.50.0  ·  npm install -g @useconvoy/cli@latest

Run that command and restart the agent. The check is best-effort — it prints nothing if npm is unreachable.

Alternative: from a checkout

git clone https://github.com/packtrain/convoy.git
cd convoy
pnpm install
pnpm cli:dev --help
pnpm cli:dev setup
pnpm cli:dev connect

pnpm cli:dev is defined in the repo root package.json and runs the CLI directly from apps/cli/. Wherever these docs show convoy <command>, substitute pnpm cli:dev <command>.

Verify the install

convoy --help
convoy status

If you have not configured any profiles yet, the CLI will tell you to run convoy setup — that is the next step: Setup and connect.