Skip to content

CLI Usage

Commands

CommandDescription
cms devStart CMS in development mode with file watching
cms startStart CMS in production mode
cms buildBuild CMS for production
cms generateRun code generation pipeline
cms migrateGenerate and run database migrations
cms typegenGenerate TypeScript types from schemas
cms lintValidate schema definitions
cms doctorCheck project health
cms collection createScaffold a new collection
cms plugin createScaffold a new plugin

Flags

cms dev

FlagDescriptionDefault
--dir <path>Schema directory./cms
--port <num>Server port3000
--host <addr>Server host0.0.0.0
--db-url <url>Database URLfile:./cms.db
--db-adapter <type>Database adaptersqlite
--viteStart Vite dev server for admin UI with HMRfalse

cms start

FlagDescriptionDefault
--dir <path>Schema directory./cms
--port <num>Server port3000
--host <addr>Server host0.0.0.0
--db-url <url>Database URLfile:./cms.db
--db-adapter <type>Database adaptersqlite

cms build

FlagDescriptionDefault
--cleanClean output directoryfalse
--out-dir <path>Output directory./dist

Other Commands

FlagCommandsDescription
--dir <path>migrate, generate, typegen, lint, doctorSchema directory
--fixlintAuto-fix issues
--out <path>generate, typegenOutput directory
--db <path>migrateDatabase file path

Quick Start

bash
# Start development
cms dev

# Start with Vite dev server (HMR for admin panel)
cms dev --vite

# Check your setup
cms doctor

# Scaffold a collection
cms collection create posts

# Generate types and APIs
cms generate

# Run migrations
cms migrate

# Build for production
cms build

# Start production server
cms start

Released under the MIT License.