Skip to main content
The CLI gives an agent the same operations as the MCP server as shell commands, with JSON output and documented exit codes. Use it when your agent runs shell commands rather than MCP tools, or in a CI job. Check the prerequisites first: an API key and, for the npm install, Node.js 20 or later.

Create an API key

In the dashboard, go to API Keys and create a key with the Sending only permission, and leave Restrict to domains empty. Copy it. Pick Full access instead for an agent that manages domains, inboxes, webhooks or agent memory. See API keys.

Install

Install it with npm, Homebrew or the PowerShell installer:

Save your key and send an email

nuntly login asks for the key without echoing it, then for an API base URL: leave it empty. It saves both to ~/.nuntly/config.json (%USERPROFILE%\.nuntly\config.json on Windows). An agent or a CI job sets the NUNTLY_API_KEY environment variable instead, which the CLI reads when no profile is selected. The onboarding sender hello@onboarding.nuntly.com only delivers to the email address of your Nuntly account (the organization owner). Add a domain to send to anyone else.

Confirmations

Destructive commands and broadcasts send ask for confirmation, and refuse to run without a terminal unless you pass --yes. Run nuntly <command> --help for every option, and see CLI for the other install methods. When a command fails with a 401 or a 403, see Troubleshooting for what each error means.