CLI Commands Reference

NextReady CLI Reference

Complete reference for all NextReady CLI commands, scripts, and development tools. Master your development workflow with our comprehensive command-line interface.

40+ Commands
Interactive wizards
Auto-validation

Core Commands

setupCore
Interactive wizard to configure your NextReady project

Command:

npm run setup

Features:

  • Project information setup
  • Database configuration
  • Authentication providers
  • Feature selection
  • Environment generation

Options:

--skip-databaseSkip database configuration
--skip-authSkip authentication setup
--minimalUse defaults without prompts

Examples:

npm run setup

Full interactive setup wizard

npm run setup -- --minimal

Quick setup with minimal prompts

validateCore
Validates your project setup and configuration

Command:

npm run validate

Features:

  • System requirements check
  • Project structure integrity
  • Environment variables validation
  • Service connections testing

Options:

--fixAuto-fix common issues automatically

Examples:

npm run validate

Run full project validation

npm run validate -- --fix

Validate and fix issues automatically

customizeCore
Customize project branding, theme, and features

Command:

npm run customize

Features:

  • App branding and colors
  • Theme configuration
  • Font selection
  • Feature toggles

Options:

--brandConfigure branding only
--themeConfigure theme only
--featuresConfigure features only

Examples:

npm run customize

Interactive customization wizard

npm run customize -- --brand

Brand customization only

All Commands by Category

Development Commands
Commands for development, building, and code quality
dev
Start development server
npm run dev
build
Build for production with formatting and Prisma generation
npm run build
start
Start production server
npm start
type-check
Run TypeScript type checking
npm run type-check
lint
Run ESLint for code quality
npm run lint
lint:fix
Fix ESLint issues automatically
npm run lint:fix
format
Format code with Prettier
npm run format
format:check
Check code formatting
npm run format:check