> ## Documentation Index
> Fetch the complete documentation index at: https://nuntly.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Install the Nuntly CLI on macOS, Linux or Windows, sign in with an API key, and send emails, manage domains and webhooks from your terminal or CI.

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](https://github.com/nuntly/nuntly-cli#readme) covers authentication, scripting and exit codes, and [SKILL.md](https://github.com/nuntly/nuntly-cli/blob/main/SKILL.md) lists every command and flag.

## Install

### macOS and Linux

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/nuntly/nuntly-cli/main/scripts/install.sh | bash
```

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:

```bash theme={null}
brew install nuntly/tap/nuntly
```

### Windows

In PowerShell:

```powershell theme={null}
irm https://raw.githubusercontent.com/nuntly/nuntly-cli/main/scripts/install.ps1 | iex
```

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:

```bash theme={null}
npm install -g @nuntly/cli
```

To run one command without installing anything:

```bash theme={null}
npx @nuntly/cli emails list
```

### Standalone binary

Each [GitHub Release](https://github.com/nuntly/nuntly-cli/releases) ships one binary per platform, with a matching `.sha256` checksum file. The binary embeds its JavaScript runtime, so nothing else needs to be installed.

| Platform | Binary |
| - | - |
| macOS ARM (M1, M2, M3) | `nuntly-darwin-arm64` |
| macOS Intel | `nuntly-darwin-x64` |
| Linux x64 | `nuntly-linux-x64` |
| Linux ARM | `nuntly-linux-arm64` |
| Windows x64 | `nuntly-windows-x64.exe` |

## Sign in

Create an API key in the dashboard (see [API keys](/docs/guides/api-keys.md)), then save it:

```bash theme={null}
nuntly login
```

The CLI asks for the key without echoing it. In CI, set `NUNTLY_API_KEY` instead.

## Send an email

```bash theme={null}
nuntly emails send \
  --from hello@yourcompany.com \
  --to user@example.com \
  --subject "Welcome" \
  --html "<h1>Welcome!</h1>"
```

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.