- Overview
- CLI
Overview
CLI
After installing the React Email package (or cloning a starter), you can start using the command line interface (CLI).
email dev
Starts a local development server that will watch your files and automatically rebuild your email when you make changes.
Options
--dirDefault: emails
string
Change the directory of your email templates.
--portDefault: 3000
string
Port to run dev server on
email export
Generates the plain HTML files of your emails into a out directory.
Options
--dirDefault: emails
string
Change the directory of your email templates.
--outDirDefault: out
string
Change the output directory.
--prettyDefault: false
boolean
Minify or prettify the generated HTML file.
--plainTextDefault: false
boolean
Set output format as plain text.
email help <cmd>
Shows all the options for a specific command.