CLI

The boilerplate includes a CLI for scaffolding collections, globals, and blocks. All commands run through DDEV to keep environments consistent. Access it via DDEV:

ddev pnpm cli <command>

Available Commands

scaffold collection

Scaffolds a new PayloadCMS collection with sensible defaults.

ddev pnpm cli scaffold collection <name> [options]

Arguments:

• name — Collection name in kebab-case (e.g., blog-posts)

Options:

• --type <type> — Collection type: public or private (default: public)

Example:

# Interactive prompt
ddev pnpm cli scaffold collection

# With arguments
ddev pnpm cli scaffold collection blog-posts --type public

What it creates:

• src/collections/[name].ts with full configuration
• SEO fields (meta title, description, image)
• Access control defaults
• Revalidation hooks
• Version tracking

After running:

1. Add the collection to payload.config.ts
2. Add to src/lib/url/slug.ts for SEO
3. Add to src/app/(frontend)/sitemap.ts
4. Run ddev pnpm generate:types
5. Create the frontend route in src/app/(frontend)/[name]/

---

scaffold global

Scaffolds a new PayloadCMS global.

ddev pnpm cli scaffold global <name>

Arguments:

• name — Global name in kebab-case (e.g., site-settings)

Example:

# Interactive prompt
ddev pnpm cli scaffold global

# With argument
ddev pnpm cli scaffold global site-settings

What it creates:

• src/globals/[name].ts with full configuration

After running:

Add the global to payload.config.ts and run ddev pnpm generate:types.

---

scaffold block

Scaffolds a new content block with config and component files.

ddev pnpm cli scaffold block <name>

Arguments:

• name — Block name in kebab-case (e.g., hero-banner)

Example:

# Interactive prompt
ddev pnpm cli scaffold block

# With argument
ddev pnpm cli scaffold block hero-banner

What it creates:

• src/blocks/[name]/config.ts — Block configuration
• src/blocks/[name]/[name]-block.tsx — React component
• src/blocks/[name]/[name].scss — Styles

After running:

1. Register the block in RenderBlocks.tsx
2. Add the block to a collection’s blocks array

---

feature

Adds or removes optional boilerplate features. Features ship outside the lean base and are installed on demand — forms is the first.

ddev pnpm cli feature add <name>
ddev pnpm cli feature remove <name>
ddev pnpm cli feature list

Example:

ddev pnpm cli feature add forms

What add forms does:

• Copies the form renderer into src/components/form/ and the plugin config into src/plugins/
• Adds the @payloadcms/plugin-form-builder, react-hook-form, and @hookform/resolvers dependencies
• Registers the plugin in src/plugins/plugins.ts

After running:

1. ddev pnpm install
2. ddev pnpm generate:types
3. Create a migration: ddev pnpm payload migrate:create

See the Forms guide for details.

---

Project Scripts

Beyond the custom CLI, these scripts are available:

Command	Purpose
ddev pnpm dev	Start development server
ddev pnpm build	Build for production
ddev pnpm lint	Run Biome and Stylelint
ddev pnpm format	Auto-format code
ddev pnpm test	Run tests
ddev pnpm generate:types	Generate PayloadCMS types
ddev pnpm payload migrate	Run database migrations
ddev pnpm payload migrate:status	Check migration status