Scaffold a project from a GitHub starter repo (user/repo):
maizzle new maizzle/maizzle
Specify a target directory:
maizzle new maizzle/maizzle my-project
Automatically install dependencies:
maizzle new maizzle/maizzle my-project --install
Use a specific package manager:
maizzle new maizzle/maizzle my-project --install --pm pnpm
Development
Start a local development server:
maizzle serve
maizzle dev is an alias for maizzle serve.
Build
Build emails for production:
maizzle build
Options
Option
Description
-c, --config <path>
Path to a Maizzle config file
-o, --output <path>
Output directory
--dir <path>
Source directory for email templates
--ext <extension>
Output file extension
--pretty
Pretty-print HTML output
--minify
Minify HTML output
--plaintext
Generate plaintext versions alongside HTML
When -c, --config is set, the override flags (-o, --dir, --ext, --pretty, --minify, --plaintext) are ignored — your config file is used as-is.
Prepare
Generate IDE type definitions in .maizzle/. Run after adding new components or composables when you want auto-import types to update without starting the dev server:
maizzle prepare
Scaffolding
You may use the make command to scaffold new files for your project.
Template
Create a new email template:
maizzle make:template [filepath]
Layout
Create a new email layout with the base HTML email structure and a default slot: