Getting started

To get started, open a new shell and run:

npx create-email

This will create a new folder called emails with a few email templates.

Commands

email dev

Starts a local development server that will watch your files and automatically rebuild your email when you make changes.

npx react-email dev

email export

Generates the plain HTML files of your emails into a out directory.

npx react-email export

Setting Up the Environment

When working in the CLI, a lot of friction can get introduced with installing it and rebuilding for every change. To avoid that, we have a script that can be linked globally to directly run the source code of the CLI. You can use it the same as you would the standard CLI.

1. Link react-email globally

pnpm link ./dev -g

2. Run the CLI

email-dev [command] [flags]

License

MIT License