@cakemail-org/cakemail-cli

v1.7.0

Published

17 hours ago

Official Cakemail CLI - Command-line interface for the Cakemail API

0High
0Medium
0Low

cakemail cli email email-marketing api command-line campaigns transactional-email analytics

Cakemail CLI

Official command-line interface for the Cakemail API.

Built on top of the official @cakemail-org/cakemail-sdk with 100% API coverage (232 operations).

Installation

via Homebrew (macOS/Linux)

brew tap cakemail/cakemail
brew install cakemail-cli

via npm

npm install -g @cakemail-org/cakemail-cli

via npx (no installation)

npx @cakemail-org/cakemail-cli --help

Quick Start

No setup required! Just run any command and the CLI will guide you through authentication:

cakemail campaigns list

The CLI will prompt for your email and password, then save OAuth tokens to ~/.cakemail/config.json.

NEW in v1.7.0: The CLI now uses OAuth token-based authentication. Your password is never stored - only secure access and refresh tokens are saved.

Profile System (NEW in v1.5.0)

Choose a profile that matches your workflow:

Developer: Fast, scriptable, no interruptions (JSON output, no prompts, no confirmations)
Marketer: Guided, interactive, safe (Compact output, prompts, confirmations, tips)
Balanced: Best of both worlds (Table output, auto-detect prompts, confirmations) - Default

# Switch profiles
cakemail config profile-set developer  # For scripts and automation
cakemail config profile-set marketer   # For exploratory work
cakemail config profile-set balanced   # For general use

# Preview a profile before switching
cakemail config preview developer

# Override profile for one command
cakemail --profile developer campaigns list

# Disable all prompts for scripting
cakemail --batch campaigns create --name "Test" --list-id 123 --sender-id 456

Manual Configuration (Optional)

You can also configure manually with environment variables or .env file:

# Option 1: Use email/password
export [email protected]
export CAKEMAIL_PASSWORD=your_password

# Option 2: Use access token
export CAKEMAIL_ACCESS_TOKEN=your_access_token

# Optional: Set default output format
export CAKEMAIL_OUTPUT_FORMAT=compact  # json, table, or compact

Or create a .env file in your project directory:

# Authentication (choose one method)
[email protected]
CAKEMAIL_PASSWORD=your_password
# OR
# CAKEMAIL_ACCESS_TOKEN=your_access_token

# Optional: Default output format (json, table, compact)
CAKEMAIL_OUTPUT_FORMAT=compact

# Optional: API base URL (defaults to https://api.cakemail.dev)
# CAKEMAIL_API_BASE=https://api.cakemail.dev

Usage

cakemail [options] <command>

Global Options

-f, --format <format> - Output format: json, table, or compact (default: json)
--profile <type> - Override profile for this command: developer, marketer, or balanced
--batch - Run in batch/scripting mode (disable all interactive prompts)
--access-token <token> - Override access token from environment
--email <email> - Override email from environment
--password <password> - Override password from environment
--account <id> - Override account ID for this command

Output Formats

The CLI supports three output formats. You can set a default in your .env file with CAKEMAIL_OUTPUT_FORMAT or override it per-command with the -f flag.

Priority: CLI flag (-f) > Environment variable (CAKEMAIL_OUTPUT_FORMAT) > Default (json)

JSON (default) - Full structured data output:

cakemail campaigns list
cakemail -f json campaigns list

Table - Formatted table view with key fields:

cakemail -f table campaigns list
cakemail -f table templates list

Compact - One-line summary per item:

cakemail -f compact lists list
cakemail -f compact contacts list 123

Set a default format:

# In your .env file
CAKEMAIL_OUTPUT_FORMAT=compact

# Now all commands use compact by default
cakemail campaigns list         # Uses compact
cakemail -f json campaigns list # Override to JSON

Commands

Profile Management (v1.5.0+) & Logout (NEW in v1.7.0)

# Show current profile and settings
cakemail config profile

# Switch to a different profile
cakemail config profile-set developer   # Fast, scriptable
cakemail config profile-set marketer    # Guided, interactive
cakemail config profile-set balanced    # Balanced (default)

# Preview a profile without switching
cakemail config preview developer
cakemail config preview marketer

# Customize individual settings
cakemail config set output.format table
cakemail config set behavior.confirm_destructive false
cakemail config set display.date_format iso8601

# Reset all settings to profile defaults
cakemail config reset

# Show complete configuration
cakemail config show

# Logout and clear all credentials (NEW in v1.7.0)
cakemail logout              # Interactive confirmation
cakemail logout --force      # Skip confirmation

Email API v2

# Send an email with HTML content
cakemail emails send -t [email protected] -s "Subject" --html "<h1>Hello</h1>"

# Send an email with HTML file
cakemail emails send -t [email protected] -s "Subject" --html-file email.html

# Send an email using a template
cakemail emails send -t [email protected] -s "Subject" --template-id 123 --params '{"name":"John"}'

# Send with custom sender
cakemail emails send \
  -t [email protected] \
  -s "Subject" \
  --html "<p>Content</p>" \
  --from-email [email protected] \
  --from-name "John Doe" \
  --reply-to [email protected]

# Send with tracking and tags
cakemail emails send \
  -t [email protected] \
  -s "Subject" \
  --html "<p>Content</p>" \
  --tracking \
  --tags "newsletter,promo"

# Get email details
cakemail emails get <email-id>

# Render email HTML
cakemail emails render <email-id>
cakemail emails render <email-id> --as-submitted --tracking

Templates

# List all templates
cakemail templates list [options]
  -l, --limit <number>    Limit results
  -p, --page <number>     Page number
  -f, --filter <filter>   Filter (e.g., "name==Newsletter")
  -s, --sort <sort>       Sort (e.g., "+name", "-created_on")

# Get template details
cakemail templates get <id>

# Create a template
cakemail templates create -n "My Template" --html-file template.html
  -n, --name <name>         Template name (required)
  --html <html>             HTML content
  --html-file <path>        Path to HTML file
  --text <text>             Plain text content
  --text-file <path>        Path to text file
  --subject <subject>       Default email subject
  --tags <tags>             Comma-separated tags

# Update a template
cakemail templates update <id> [options]
  -n, --name <name>         Template name
  --html <html>             HTML content
  --html-file <path>        Path to HTML file
  --text <text>             Plain text content
  --text-file <path>        Path to text file
  --subject <subject>       Default email subject
  --tags <tags>             Comma-separated tags

# Render a template
cakemail templates render <id>

# Delete template
cakemail templates delete <id> --force

Campaigns

# List all campaigns
cakemail campaigns list [options]
  -s, --status <status>     Filter by status
  -l, --limit <number>      Limit results
  -p, --page <number>       Page number
  --sort <sort>             Sort (e.g., "+name", "-created_on", "+scheduled_for")
  --filter <filter>         Filter (e.g., "status==delivered;name==Newsletter")

# Get campaign details
cakemail campaigns get <id>

# Create a campaign (interactive in marketer/balanced profiles)
cakemail campaigns create -n "My Campaign" -l <list-id> [options]
  -n, --name <name>         Campaign name (prompts if missing)
  -l, --list-id <id>        List ID (auto-detects or shows selection)
  -s, --sender-id <id>      Sender ID (auto-detects or shows selection)
  -t, --template-id <id>    Template ID
  --subject <subject>       Email subject

# Interactive example (marketer profile)
cakemail campaigns create
# Prompts: Campaign name? Select list? Select sender?

# Non-interactive example (developer profile or --batch)
cakemail campaigns create --name "Newsletter" --list-id 123 --sender-id 456

# Update a campaign
cakemail campaigns update <id> [options]
  -n, --name <name>         Campaign name
  -l, --list-id <id>        List ID
  -s, --sender-id <id>      Sender ID
  -t, --template-id <id>    Template ID
  --subject <subject>       Email subject

# Schedule a campaign
cakemail campaigns schedule <id> -d <datetime>
  -d, --date <datetime>   Schedule datetime (ISO 8601)

# Reschedule a campaign
cakemail campaigns reschedule <id> -d <datetime>
  -d, --date <datetime>   New schedule datetime (ISO 8601)

# Unschedule a campaign
cakemail campaigns unschedule <id>

# Send test email
cakemail campaigns test <id> -e <email>
  -e, --email <email>     Recipient email

# Archive/Unarchive campaign
cakemail campaigns archive <id>
cakemail campaigns unarchive <id>

# Cancel a scheduled campaign
cakemail campaigns cancel <id>

# Suspend/Resume campaign
cakemail campaigns suspend <id>
cakemail campaigns resume <id>

# List campaign links
cakemail campaigns links <id> [options]
  -l, --limit <number>    Limit results
  -p, --page <number>     Page number

# Delete campaign
cakemail campaigns delete <id> --force

Lists

# List all contact lists
cakemail lists list [options]
  -l, --limit <number>      Limit results
  -p, --page <number>       Page number
  --sort <sort>             Sort (e.g., "+name", "-created_on")
  --filter <filter>         Filter (e.g., "status==active;name==Newsletter")

# Get list details
cakemail lists get <id>

# Create a list (interactive in marketer/balanced profiles)
cakemail lists create -n "My List" [options]
  -n, --name <name>       List name (prompts if missing)
  -l, --language <lang>   Language code (optional, prompts in interactive mode)

# Interactive example
cakemail lists create
# Prompts: List name? Language code (optional)?

# Non-interactive example
cakemail lists create --name "Newsletter Subscribers" --language en

# Delete list
cakemail lists delete <id> --force

Contacts

# List contacts in a list
cakemail contacts list <list-id> [options]
  -l, --limit <number>      Limit results
  -p, --page <number>       Page number
  -q, --query <query>       Search query
  --sort <sort>             Sort (e.g., "+email", "-subscribed_on", "+status")
  --filter <filter>         Filter (e.g., "status==active;[email protected]")

# Get contact details
cakemail contacts get <list-id> <contact-id>

# Add a contact
cakemail contacts add <list-id> -e <email> [options]
  -e, --email <email>         Contact email (required)
  -f, --first-name <name>     First name
  -l, --last-name <name>      Last name
  -d, --data <json>           Custom attributes as JSON

# Update contact
cakemail contacts update <list-id> <contact-id> [options]
  -e, --email <email>         Contact email
  -f, --first-name <name>     First name
  -l, --last-name <name>      Last name
  -d, --data <json>           Custom attributes as JSON

# Delete contact
cakemail contacts delete <list-id> <contact-id> --force

# Unsubscribe contact
cakemail contacts unsubscribe <list-id> <contact-id>

Senders

# List all senders
cakemail senders list [options]
  -l, --limit <number>      Limit results
  -p, --page <number>       Page number
  --sort <sort>             Sort (e.g., "+name", "+email", "-confirmed")
  --filter <filter>         Filter (e.g., "confirmed==true;[email protected]")

# Get sender details
cakemail senders get <id>

# Create a sender
cakemail senders create -n "John Doe" -e "[email protected]"
  -n, --name <name>     Sender name (required)
  -e, --email <email>   Sender email (required)

# Update a sender
cakemail senders update <id> [options]
  -n, --name <name>     Sender name
  -e, --email <email>   Sender email

# Confirm sender (using confirmation ID from email)
cakemail senders confirm <confirmation-id>

# Resend confirmation email
cakemail senders resend-confirmation <id>

# Delete sender
cakemail senders delete <id> --force

Webhooks

# List all webhooks
cakemail webhooks list [options]
  -l, --limit <number>    Limit results
  -p, --page <number>     Page number

# Get webhook details
cakemail webhooks get <id>

# Create a webhook
cakemail webhooks create -u <url> -e <events> [options]
  -u, --url <url>         Webhook URL (required)
  -e, --events <events>   Comma-separated events (required)
  -n, --name <name>       Webhook name
  -s, --secret <secret>   Webhook secret for verification

# Update a webhook
cakemail webhooks update <id> [options]
  -u, --url <url>         Webhook URL
  -e, --events <events>   Comma-separated events
  -n, --name <name>       Webhook name
  -s, --secret <secret>   Webhook secret

# Archive a webhook
cakemail webhooks archive <id>

# Unarchive a webhook
cakemail webhooks unarchive <id>

Reports & Analytics (NEW in v1.3)

# Campaign analytics
cakemail reports campaign <id>
cakemail reports campaign-links <id>

# List analytics
cakemail reports list <id>

# Account analytics
cakemail reports account

# Email API statistics
cakemail reports emails --from 2025-01-01 --to 2025-12-31
cakemail reports emails-summary
cakemail reports transactional-emails

# Export campaign reports
cakemail reports export-campaigns --from 2025-01-01 --status delivered
cakemail reports campaigns-exports
cakemail reports campaigns-export <export-id>
cakemail reports download-campaigns-export <export-id>
cakemail reports delete-campaigns-export <export-id> --force

Segments (NEW in v1.3)

# List all segments
cakemail segments list <list-id>

# Get segment details
cakemail segments get <list-id> <segment-id>

# Create a segment
cakemail segments create <list-id> -n "Active Users" -c '{"conditions":[...]}'

# Update segment
cakemail segments update <list-id> <segment-id> -n "New Name"

# Delete segment
cakemail segments delete <list-id> <segment-id> --force

# List contacts in segment
cakemail segments contacts <list-id> <segment-id>

Custom Attributes (NEW in v1.3)

# List all custom attributes
cakemail attributes list <list-id>

# Get attribute details
cakemail attributes get <list-id> <attribute-name>

# Create custom attribute
cakemail attributes create <list-id> -n "company" -t text
cakemail attributes create <list-id> -n "age" -t number
cakemail attributes create <list-id> -n "subscribed_date" -t date
cakemail attributes create <list-id> -n "active" -t boolean

# Delete attribute
cakemail attributes delete <list-id> <attribute-name> --force

Suppression List (NEW in v1.3)

# List suppressed emails
cakemail suppressed list

# Add to suppression list
cakemail suppressed add [email protected]

# Remove from suppression list
cakemail suppressed delete [email protected] --force

# Export suppressed emails
cakemail suppressed export
cakemail suppressed exports
cakemail suppressed export-get <export-id>
cakemail suppressed export-download <export-id>

Contact Import/Export & Tagging (NEW in v1.3)

# Import contacts from file (TODO: Not yet implemented - requires CSV/JSON parser)

# Export contacts
cakemail contacts export <list-id> --status subscribed --format csv
cakemail contacts exports <list-id>
cakemail contacts export-get <list-id> <export-id>
cakemail contacts export-download <list-id> <export-id>
cakemail contacts export-delete <list-id> <export-id> --force

# Tag single contact
cakemail contacts tag <list-id> <contact-id> -t "vip,premium"

# Untag single contact
cakemail contacts untag <list-id> <contact-id> -t "trial"

# Tag multiple contacts
cakemail contacts tag-bulk <list-id> -c "1,2,3,4,5" -t "segment-a,active"

# Untag multiple contacts
cakemail contacts untag-bulk <list-id> -c "1,2,3,4,5" -t "old-tag"

Extended List Operations (NEW in v1.3)

# Update list
cakemail lists update <id> -n "New Name" -l en_US

# Archive list
cakemail lists archive <id>

# Accept list policy
cakemail lists accept-policy <id>

# Manage subscription forms
cakemail lists forms <id>
cakemail lists form-create <id> -d "example.com" -n "Signup Form"
cakemail lists form-delete <list-id> <form-id> --force

Extended Email API (NEW in v1.3)

# View Email API logs
cakemail emails logs --from 2025-01-01 --to 2025-12-31
cakemail emails logs --tag newsletter --status delivered

# List all email tags
cakemail emails tags

Tags (NEW in v1.6.0)

# List all tags
cakemail tags list <list-id>
  -p, --page <number>     Page number
  --per-page <number>     Results per page
  --with-count            Include total count

# Show tag details
cakemail tags show <list-id> <tag-id>

# Create a tag
cakemail tags create <list-id> -n "vip" -d "VIP customers"
  -n, --name <name>           Tag name (required)
  -d, --description <text>    Tag description

# Update a tag
cakemail tags update <list-id> <tag-id> -n "premium" -d "Premium members"
  -n, --name <name>           New tag name
  -d, --description <text>    New description

# Delete a tag
cakemail tags delete <list-id> <tag-id> --force

Interests (NEW in v1.6.0)

# List all interests
cakemail interests list <list-id>
  -p, --page <number>     Page number
  --per-page <number>     Results per page
  --with-count            Include total count

# Show interest details
cakemail interests show <list-id> <interest-id>

# Create an interest
cakemail interests create <list-id> -n "Product Updates" -d "Receive product announcements"
  -n, --name <name>           Interest name (required)
  -d, --description <text>    Interest description

# Update an interest
cakemail interests update <list-id> <interest-id> -n "News" -d "Newsletter updates"
  -n, --name <name>           New interest name
  -d, --description <text>    New description

# Delete an interest
cakemail interests delete <list-id> <interest-id> --force

# Manage contact interests
cakemail contacts add-interests <list-id> -i "Product Updates,News" -c "1,2,3"
cakemail contacts add-interests <list-id> -i "Newsletter" -q "status='subscribed'"
cakemail contacts remove-interests <list-id> -i "Old Interest" -c "1,2,3"
  -i, --interests <interests>   Comma-separated interest names (required)
  -c, --contacts <ids>          Comma-separated contact IDs
  -q, --query <query>           SQL query to select contacts

Campaign Enhancements (NEW in v1.6.0)

# Enhanced campaign commands with additional filters
cakemail campaigns list --sort "+scheduled_for"  # Sort by scheduled date
cakemail campaigns list --filter "status==delivered;name==Newsletter"

# Show rendered campaign HTML
cakemail campaigns show-html <id>

# Get campaign statistics
cakemail campaigns stats <id>

Activity Logs (NEW in v1.6.0)

# Campaign activity logs
cakemail logs campaign <campaign-id>
  --from <date>           Filter by start date (YYYY-MM-DD)
  --to <date>             Filter by end date (YYYY-MM-DD)
  --status <status>       Filter by status
  -p, --page <number>     Page number
  --per-page <number>     Results per page

# List activity logs
cakemail logs list <list-id>
  --from <date>           Filter by start date
  --to <date>             Filter by end date
  --status <status>       Filter by status
  -p, --page <number>     Page number
  --per-page <number>     Results per page

# Show single log entry
cakemail logs show <list-id> <log-id>

Transactional Templates (NEW in v1.6.0)

# List transactional templates
cakemail transactional-templates list [list-id]
  -p, --page <number>     Page number
  --per-page <number>     Results per page
  --with-count            Include total count

# Show template details
cakemail transactional-templates show [list-id] <template-id>

# Create a transactional template
cakemail transactional-templates create [list-id] \
  -n "Order Confirmation" \
  -s "Your Order #{{order_id}}" \
  --html "<h1>Order Confirmation</h1>" \
  --sender-id 123
  -n, --name <name>         Template name (required)
  -s, --subject <subject>   Email subject (required)
  --html <html>             HTML content (required)
  --text <text>             Plain text content
  --sender-id <id>          Sender ID
  --tracking <tracking>     Tracking settings

# Update a template
cakemail transactional-templates update [list-id] <template-id> \
  -n "New Name" \
  -s "New Subject"
  -n, --name <name>         Template name
  -s, --subject <subject>   Email subject
  --html <html>             HTML content
  --text <text>             Plain text content
  --sender-id <id>          Sender ID
  --tracking <tracking>     Tracking settings

# Delete a template
cakemail transactional-templates delete [list-id] <template-id> --force

# Send transactional email from template
cakemail transactional-templates send [list-id] <template-id> \
  -c 456 \
  --variables '{"order_id":"12345"}'
  -c, --contact-id <id>     Contact ID to send to
  -e, --email <email>       Email address (alternative to contact-id)
  --variables <json>        Template variables as JSON

# Send test email
cakemail transactional-templates test [list-id] <template-id> \
  -e "[email protected]" \
  --variables '{"order_id":"TEST"}'
  -e, --email <email>       Email address (required)
  --variables <json>        Template variables as JSON

# Render template preview
cakemail transactional-templates render [list-id] <template-id> \
  -c 456 \
  --variables '{"order_id":"12345"}'
  -c, --contact-id <id>     Contact ID for personalization
  --variables <json>        Template variables as JSON

Examples

# Create a template
cakemail templates create \
  -n "Newsletter Template" \
  --html-file templates/newsletter.html \
  --subject "Weekly Newsletter" \
  --tags "newsletter,weekly"

# Send a transactional email
cakemail emails send \
  -t [email protected] \
  -s "Order Confirmation" \
  --html-file templates/order-confirmation.html \
  --from-email [email protected] \
  --from-name "My Shop" \
  --tracking \
  --tags "transactional,order"

# Manage campaign lifecycle
cakemail campaigns schedule 123 -d "2025-10-15T10:00:00Z"
cakemail campaigns suspend 123
cakemail campaigns resume 123
cakemail campaigns cancel 123

# List campaigns in table format
cakemail -f table campaigns list

# List campaigns in compact format
cakemail -f compact campaigns list

# Sort and filter campaigns
cakemail campaigns list --sort "-created_on" --filter "status==delivered"
cakemail campaigns list --sort "+name"

# Sort and filter lists
cakemail lists list --sort "+name" --filter "status==active"

# Sort and filter contacts
cakemail contacts list 123 --sort "-subscribed_on" --filter "status==active"

# Sort and filter senders
cakemail senders list --sort "+email" --filter "confirmed==true"

# Create a new list
cakemail lists create -n "Newsletter Subscribers" -l en

# Add a contact with custom attributes
cakemail contacts add 123 -e "[email protected]" -f "John" -l "Doe" -d '{"company":"Acme"}'

# Schedule a campaign
cakemail campaigns schedule 456 -d "2025-10-15T10:00:00Z"

# Send a test campaign
cakemail campaigns test 456 -e "[email protected]"

# Create a webhook for email events
cakemail webhooks create \
  -u "https://example.com/webhook" \
  -e "email.sent,email.opened,email.clicked" \
  -n "My Webhook" \
  -s "my_secret_key"

Development

# Install dependencies
npm install

# Build
npm run build

# Run locally
npm start -- campaigns list

# or use node directly
node dist/cli.js campaigns list

Testing

The CLI has a comprehensive test suite:

# Run all tests
npm test

# Run integration tests (requires real API credentials)
npm run test:integration

# Run PTY tests (requires Node 18-20)
npm run test:pty

# Generate coverage report
npm run test:coverage

# Watch mode for development
npm run test:watch

Test Types:

Integration Tests - Test against real Cakemail API
- Requires credentials in .env file
- Tests real API calls and responses
- Currently: 5 passing tests
PTY Tests - Simulate real terminal user experience
- Tests colors, spinners, interactive prompts
- Tests all output formats (JSON, table, compact)
- Requires Node 18.x or 20.x (node-pty compatibility)
- Uses mock HTTP server for isolated testing

Setting up Integration Tests:

Create a .env file with test credentials:

[email protected]
CAKEMAIL_PASSWORD=your_test_password

PTY Tests (Note):

PTY tests require Node 18 or 20 due to node-pty compilation limitations with Node 24+. If you're on Node 24:

# Switch to Node 20 for PTY tests
nvm install 20
nvm use 20
npm install
npm run test:pty

See tests/PTY_TESTING_GUIDE.md for complete testing documentation.

License

MIT

Support

For issues and questions, please visit: https://github.com/cakemail/cli/issues