@velocms/cli

@velocms/cli

The official VeloCMS developer CLI. Build, test, and publish plugins and themes to the VeloCMS marketplace.

Installation

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

Commands

Command	Description
velocms login	Authenticate with velocms.org via browser OAuth
velocms dev	Start local dev server with TypeScript hot-reload
velocms test	Run the plugin/theme test suite (auto-detects Vitest)
velocms build	Compile and pack a publishable .tgz artifact
velocms publish	Upload to marketplace as a draft (requires login)
velocms logout	Clear stored credentials

Quick start

# Scaffold a new plugin
npx create-velocms-plugin my-plugin

# Enter the project
cd my-plugin && npm install

# Start dev server
velocms dev

# Run tests
velocms test

# Build for publishing
velocms build

# Publish draft to marketplace
velocms login  # first time only
velocms publish

Authentication

velocms login uses the OAuth 2.0 Device Authorization Grant (RFC 8628). Your browser opens https://velocms.org/developers/auth — approve access there, and the CLI receives a token automatically.

Credentials are stored at ~/.velocms/credentials.json (mode 600).

Environment variables

Variable	Default	Purpose
VELOCMS_API_URL	https://velocms.org	Override API base URL for testing
VELOCMS_DEV_URL	http://localhost:3000	Local VeloCMS instance for dev command

Docs

Full developer documentation: velocms.org/developers/docs

License

MIT