Mailaura CLI

Official command-line tool for the Mailaura Email Marketing Platform.

Installation

npm install -g @adsimple/mailaura-cli

Or run without installing:

npx @adsimple/mailaura-cli --help

Authentication

An API key is required for all commands. Generate one in your dashboard under Settings → API.

Pass it via flag or environment variable:

# Flag
mailaura --api-key ml_xxx domains list

# Environment variable (recommended for scripts)
export MAILAURA_API_KEY=ml_xxx
mailaura domains list

Without an API key, the CLI exits immediately with an error and a link to the dashboard.

Commands

Domains

# List all domains
mailaura domains list

# Show details for a domain
mailaura domains get <id>

# Show DNS records to configure
mailaura domains dns <id>
mailaura domains dns <id> --purpose dkim   # filter by: verification, spf, dkim, dmarc, mail_from

# Add a new domain
mailaura domains add example.com
mailaura domains add example.com --dmarc-email [email protected]

# Trigger DNS verification
mailaura domains verify <id>

# Enable custom MAIL FROM
mailaura domains mail-from <id>
mailaura domains mail-from <id> --subdomain bounce

# Delete a domain (requires --confirm)
mailaura domains delete <id> --confirm

Global Options

| Option | Description | |--------|-------------| | --api-key <key> | Mailaura API key | | --url <url> | API base URL (default: https://mailaura.io) | | --json | Output raw JSON (available on all commands) | | -V, --version | Show version | | -h, --help | Show help |

Targeting a different environment

# Staging / local
mailaura --url http://localhost:3001 domains list
# or
export MAILAURA_API_URL=http://localhost:3001
mailaura domains list

Required API Key Scopes

| Command group | Required scope | |---------------|---------------| | domains list, domains get, domains dns | domains:read | | domains add, domains verify, domains mail-from, domains delete | domains:write |

License

MIT © AdSimple GmbH