The novem cli is designed to make it easy to create, view and send your e-mails from the command line. This document provides a short overview of working with your e-mails using the novem cli
AI assisted, human approved — novem uses AI to review and keep our documentation up to date.
For this document we assume that you've already installed the novem cli and that
the novem command is available in your $PATH. If you need help installing the
novem cli please see the installation instructions.
E-mails are selected with the -m flag. On its own, -m lists all of your
e-mails; with a name it selects that e-mail for the operations described below.
# list all of your e-mails
novem -m
# select a single e-mail to operate on
novem -m monthly_update
Add -C to create the e-mail if it doesn't already exist.
novem -m monthly_update -C
Recipients live under the e-mail's recipients folder. The --to, --cc and
--bcc flags are shorthands for writing them. A recipient can be a novem user,
a novem group (@user~group / +org~group), or a
plain e-mail address; separate several with a ;.
novem -m monthly_update --to "novem_demo; investors@example.com"
novem -m monthly_update --cc "@acme~analysts"
See recipients for the address rules and any sending restrictions on your account.
novem -m monthly_update --subject "Monthly update — March"
The body is novem markdown written to the e-mail's
content. Pipe a file in on stdin, or write it with -w.
# pipe a markdown file as the body
cat body.md | novem -m monthly_update -w content
# create, set subject + recipient, and pipe the body in one go
cat body.md | novem -m monthly_update -C \
--subject "Monthly update" --to investors@example.com -w content
Send a test copy to your own registered address with -T, and send to the
real recipients with -S. Both trigger a fresh server-side render first, so the
e-mail always reflects your latest changes.
# send a test to yourself
novem -m monthly_update -T
# send to the recipients
novem -m monthly_update -S
Note: free accounts can only send to their own registered, verified address.
Read any path back with -r; the url path returns the shareable link.
novem -m monthly_update -r url
Like other novem resources, e-mails can be shared and tagged. Manage shares with
-s (add with -C, remove with -D, a bare -s lists them) and tags with
-t. See the plot page for the shared-flag
patterns — they work identically for e-mails.
novem -m monthly_update -D