mjml-cli

What is mjml-cli?

The mjml-cli package is a command-line interface for MJML, a markup language designed to reduce the pain of coding responsive emails. It allows you to easily convert MJML files into responsive HTML emails.

What are mjml-cli's main functionalities?

Convert MJML to HTML

This command converts an MJML file (input.mjml) into an HTML file (output.html).

mjml input.mjml -o output.html

Watch Mode

This command watches the input MJML file for changes and automatically converts it to HTML whenever the file is modified.

mjml -w input.mjml -o output.html

Minify Output

This command converts an MJML file to a minified HTML file, reducing the file size for better performance.

mjml input.mjml -o output.html --config.minify true

Validate MJML

This command validates the MJML file for any syntax errors or warnings.

mjml -v input.mjml

Other packages similar to mjml-cli

juice

Juice is a package that inlines CSS into HTML for email templates. While it doesn't convert MJML to HTML, it is useful for making sure your CSS is properly inlined for email clients.

pug-cli

Pug-CLI is a command-line interface for compiling Pug templates to HTML. It is similar in that it converts a template language to HTML, but it is not specifically designed for email templates.

handlebars-cli

Handlebars-CLI is a command-line tool for compiling Handlebars templates. Like MJML-CLI, it converts a template language to HTML, but it is more general-purpose and not focused on email.

README

mjml-cli

Installation

We recommend installing and using MJML locally, in a project folder where you'll use MJML:

$> npm install mjml

In the folder where you installed MJML you can now run:

$> ./node_modules/.bin/mjml input.mjml

To avoid typing ./node_modules/.bin/, add it to your PATH:

$> export PATH="$PATH:./node_modules/.bin"

You can now run MJML directly, in that folder:

$> mjml input.mjml

MJML is written with NodeJS You can download and install the MJML engine from NPM.

Command Line Interface

In addition to the translation engine, which converts MJML to email HTML, we've bundled a Command Line Interface (CLI) helping you to achieve the basic features it offers and integrate it seamlessly in your development flow.

Render MJML to HTML

$> mjml input.mjml

It will output a HTML file called input.html.

Render and redirect the result to stdout

$> mjml -s input.mjml

# or

$> mjml --stdout input.mjml

Render and minify the output HTML

$> mjml -m input.mjml

# or

$> mjml --min input.mjml

It will output a HTML file called input.html.

Render and redirect the result to a file

$> mjml input.mjml -o my-email.html

# or

$> mjml input.mjml --output my-email.html

You can output the resulting email responsive HTML in a file. If the file does not exist, it will be created.

Set the validation rule to skip so that the file is rendered without being validated.

$> mjml -l skip -r input.mjml

Watch changes on a file

$> mjml -w input.mjml

# or

$> mjml --watch input.mjml

If you like live-coding, you might want to use the -w option that enables you to re-render your file every time you save it. It can be time-saving when you can just split you screen and see the HTML output modified when you modify your MJML.

Of course, the -w option can be used with an --output option too.