CLI Reference — @velocms/cli

Installation

npm install -g @velocms/cli
# or use without installing:
npx @velocms/cli <command>

Commands

`velocms dev`

Start TypeScript watch compiler with hot-reload. Validates manifest on start.

Options:

--watch

Watch mode (default)

Environment: VELOCMS_DEV_URL — local VeloCMS instance (default: http://localhost:3000)

`velocms test`

Run the test suite. Auto-detects Vitest or node:test from package.json.

Options:

--watch, -w	Watch mode
--coverage	Generate coverage report (Vitest only)

`velocms build`

Validate manifest, run npm run build, and pack to a .tgz artifact via npm pack.

Options:

--skip-validation

Skip manifest validation (not recommended)

`velocms publish`

Upload built .tgz to marketplace as a draft. Requires login.

Options:

--dry-run

Validate and pack but do not upload

Environment: VELOCMS_API_URL — override API base (default: https://velocms.org)

`velocms login`

OAuth Device Authorization Grant login via velocms.org.

Environment: VELOCMS_API_URL — override API base

`velocms logout`

Clear stored credentials from ~/.velocms/credentials.json.

Authentication storage

Credentials are stored at ~/.velocms/credentials.json (mode 600). The file contains the access token, refresh token, expiry timestamp, developer ID, and email. Do not commit this file to source control — add ~/.velocms/ to your global .gitignore_global.