Learn more about Mintlify

Enter your email to receive updates about new features and product releases.

Maizzle CLI

You can use the Maizzle CLI to:

Installation

Install the CLI tool globally, so that the maizzle executable gets added to your $PATH:

npm install -g @maizzle/cli

Scaffold a Maizzle project by opening a terminal and running:

maizzle new

This will bring up an interactive prompt that will guide you through the process.

The CLI tool provides commands for developing HTML emails with Maizzle.

Use the maizzle serve command to start a local development server, which you can access in your browser at http://localhost:3000.

maizzle serve [env]

You can edit a template or component in your code editor, save it, and the changes will instantly be reflected in the browser.

The build command is used to compile your templates and output them to the destination directory.

maizzle build [env]

If [env] is specified, Maizzle will try to compute an environment config by merging config.[env].js on top of the default config.js.

If no [env] is specified, Maizzle will use config.js from the current working directory.

⌘I