Skip to main content
The Nuntly CLI sends emails and manages domains, webhooks, inboxes and the rest of your account from a terminal or a CI job. The README covers authentication, scripting and exit codes, and SKILL.md lists every command and flag.

​
Install

​
macOS and Linux

The script picks the binary for your OS and architecture from GitHub Releases, checks its SHA-256 checksum, and installs it to ~/.nuntly/bin. To pin a version, add -s -- --version v1.2.3 after bash. With Homebrew:

​
Windows

In PowerShell:
The script installs nuntly.exe to %USERPROFILE%\.nuntly\bin and adds that folder to your user PATH.

​
npm

With Node.js 20 or later, or Bun:
To run one command without installing anything:

​
Standalone binary

Each GitHub Release ships one binary per platform, with a matching .sha256 checksum file. The binary embeds its JavaScript runtime, so nothing else needs to be installed.

​
Sign in

Create an API key in the dashboard (see API keys), then save it:
The CLI asks for the key without echoing it. In CI, set NUNTLY_API_KEY instead.

​
Send an email

Run nuntly --help for the command list, and nuntly <command> --help for the flags of one command.