CLI Commands

VelvetCMS includes a CLI tool for common tasks. Run commands from your project root.

Basic Usage #

./velvet <command> [options] [arguments]

List all commands:

./velvet list

Get help for a command:

./velvet help migrate
./velvet migrate --help

Quick-start commands #

./velvet install
./velvet serve --port=8080
./velvet diagnose
./velvet page:make about --title="About"
./velvet page:list --status=published
./velvet module:compile
./velvet queue:work

Use this page as an orientation guide. The authoritative command inventory is Command Reference.

Options Format #

Options use these formats:

--option=value    # Key-value
--flag            # Boolean flag
-f                # Short flag

Examples:

./velvet serve --host=0.0.0.0 --port=8000
./velvet page:make hello --title="Hello World" --layout=default
./velvet config:get app.debug
./velvet config:set app.debug false

Multi-Tenancy #

When working with tenants, set the tenant context:

TENANCY_TENANT=acme ./velvet cache:clear
TENANCY_TENANT=acme ./velvet migrate
./velvet module:list --tenant=acme

Exit Codes #

Creating Custom Commands #

Generate a command scaffold:

./velvet make:command SendNewsletter

See Command Reference for all available commands and options.