novu-domains-demo-cli
v0.1.2
Published
Interactive CLI demo for Novu inbound email domains and webhook routes.
Readme
Novu Domains Demo CLI
A polished interactive TypeScript CLI for testing Novu inbound email domains with @novu/[email protected].
It walks you through:
- Creating an inbound email domain.
- Adding the required DNS records at your provider.
- Running live domain verification.
- Creating a webhook route for an address on the domain.
- Optionally sending a synthetic inbound email through the webhook route.
- Re-running webhook tests or adding another webhook route from a post-flow action menu.
Usage
Run without installing:
npx novu-domains-demo-cliOr install globally:
npm install -g novu-domains-demo-cli
novu-domains-demoLocal development
pnpm install
pnpm startYou can provide your Novu secret key in either of two ways:
- Set
NOVU_SECRET_KEYin your shell or.env. - Paste it into the masked prompt when the CLI starts.
For EU environments, set NOVU_SERVER_URL=https://eu.api.novu.co or choose the EU region in the prompt.
Environment
cp .env.example .envThen fill:
NOVU_SECRET_KEY=your-secret-key
NOVU_SERVER_URL=NOVU_SERVER_URL is optional for US. Use https://eu.api.novu.co for EU.
Notes
Webhook routes do not take a webhook URL directly. They route inbound email to the outbound webhook endpoints configured for the Novu environment.
Route tests are real synthetic deliveries. They call domains.routes.test(...) without dryRun, so configured webhook endpoints should receive an email.received event.
