CLI Reference

Complete reference for all CLI commands and options

Global Options

--help, -hShow help for a command

--version, -VShow version number

--verbose, -vEnable verbose output

--dry-runPreview changes without writing

--quiet, -qSuppress output except errors

--cwd <dir>Working directory

--config <file>Config file path

--no-colorDisable colored output

Commands by Category

Project Management

servcraft init <name>

Initialize a new ServCraft project

--ts- Use TypeScript (default)--js- Use JavaScript--prisma <db>- Database: postgres, mysql, sqlite, mongodb--validator <lib>- Validator: zod, joi, yup--esm- Use ESM modules--template <name>- Project template

servcraft doctor

Diagnose project configuration

--fix- Auto-fix common issues--verbose- Show detailed output

servcraft update

Update ServCraft and modules

--modules-only- Update only modules--dry-run- Preview changes

Module Management

servcraft add <module>

Add a pre-built module

--crud- Generate CRUD--dry-run- Preview changes

servcraft remove <module>

Remove a module

--keep-files- Keep generated files

servcraft list

List available/installed modules

--available- Show available modules--installed- Show installed modules

Code Generation

servcraft generate <type> <name>

Generate code for controllers, services, or schemas

--with-tests- Generate test files--dry-run- Preview changes

servcraft scaffold <name>

Generate complete CRUD for a resource

--with-tests- Generate test files--dry-run- Preview changes

servcraft templates

Manage custom code templates

Subcommands: listaddremoveedit

Database

servcraft db migrate

Run Prisma migrations

servcraft db push

Push schema changes

servcraft db generate

Generate Prisma client

servcraft db seed

Run database seeders

servcraft db studio

Open Prisma Studio

Documentation

servcraft docs generate

Generate API documentation

--output <path>- Output file path

servcraft docs export

Export docs to Postman/Insomnia

--format <fmt>- Format: postman, insomnia, yaml

servcraft docs status

Show documentation status

Utilities

servcraft completion

Generate shell completion

Subcommands: bashzshfish

servcraft --version

Show version

servcraft --help

Show help

Common Examples

Common CLI Examples

# Create a new TypeScript project with PostgreSQL
servcraft init my-api --ts --prisma postgres
# Add multiple modules at once
servcraft add auth users email cache
# Generate a resource with tests
servcraft scaffold blog --with-tests
# Generate just a controller
servcraft generate controller post
# Update to latest version
servcraft update
# Check project health
servcraft doctor --fix
# Generate API docs
servcraft docs generate --output ./docs/openapi.json
# Export to Postman collection
servcraft docs export --format postman