@adsimple/mailaura-cli
v0.2.2
Published
Official CLI for the Mailaura Email Marketing Platform
Downloads
48
Maintainers
Readme
Mailaura CLI
Official command-line tool for the Mailaura Email Marketing Platform — 67+ commands covering campaigns, subscribers, automations, AI content, and more.
Installation
npm install -g @adsimple/mailaura-cliOr run without installing:
npx @adsimple/mailaura-cli --helpAuthentication
An API key is required for all commands. Generate one in your dashboard under Settings → API.
# Flag
mailaura --api-key ml_xxx campaigns list
# Environment variable (recommended)
export MAILAURA_API_KEY=ml_xxx
mailaura campaigns listCommands
Campaigns
mailaura campaigns list # List all campaigns
mailaura campaigns get <id> # Show campaign details
mailaura campaigns create # Create a campaign (interactive)
mailaura campaigns update <id> # Update a campaign
mailaura campaigns delete <id> --confirm # Delete a campaign
mailaura campaigns send <id> # Send a campaign
mailaura campaigns schedule <id> # Schedule a campaign
mailaura campaigns cancel <id> # Cancel a scheduled campaign
mailaura campaigns duplicate <id> # Duplicate a campaign
mailaura campaigns preview <id> # Preview campaign HTML
mailaura campaigns test <id> # Send a test emailLists
mailaura lists list # List all subscriber lists
mailaura lists get <id> # Show list details
mailaura lists create --name "My List" # Create a list
mailaura lists update <id> --name "New Name" # Update a list
mailaura lists delete <id> --confirm # Delete a listSubscribers
mailaura subscribers list # List subscribers
mailaura subscribers get <id> # Show subscriber details
mailaura subscribers add --email [email protected] --list <id> # Add subscriber
mailaura subscribers update <id> # Update subscriber
mailaura subscribers delete <id> --confirm # Remove subscriber
mailaura subscribers import --file data.csv --list <id> # Bulk import
mailaura subscribers export --list <id> # Export subscribersTemplates
mailaura templates list # List all templates
mailaura templates get <id> # Show template details
mailaura templates create # Create a template
mailaura templates update <id> # Update a template
mailaura templates delete <id> --confirm # Delete a template
mailaura templates duplicate <id> # Duplicate a templateTags
mailaura tags list # List all tags
mailaura tags get <id> # Show tag details
mailaura tags create --name "VIP" # Create a tag
mailaura tags update <id> --name "Premium" # Rename a tag
mailaura tags delete <id> --confirm # Delete a tag
mailaura tags assign <tagId> <subscriberId> # Assign tag to subscriber
mailaura tags remove <tagId> <subscriberId> # Remove tag from subscriberAutomations
mailaura automations list # List all automations
mailaura automations get <id> # Show automation details
mailaura automations create # Create an automation
mailaura automations update <id> # Update an automation
mailaura automations delete <id> --confirm # Delete an automation
mailaura automations activate <id> # Activate an automation
mailaura automations pause <id> # Pause an automation
mailaura automations runs <id> # List automation runs
mailaura automations steps list <id> # List steps of an automation
mailaura automations steps add <id> # Add a step
mailaura automations steps update <autoId> <stepId> # Update a step
mailaura automations steps delete <autoId> <stepId> # Delete a stepRSS Campaigns
mailaura rss list # List RSS campaigns
mailaura rss get <id> # Show RSS campaign details
mailaura rss create # Create an RSS campaign
mailaura rss update <id> # Update an RSS campaign
mailaura rss delete <id> --confirm # Delete an RSS campaign
mailaura rss activate <id> # Activate RSS campaign
mailaura rss pause <id> # Pause RSS campaign
mailaura rss check <id> # Check RSS feed for new items
mailaura rss history <id> # Show send historyDomains
mailaura domains list # List all domains
mailaura domains get <id> # Show domain details
mailaura domains add example.com # Add a new domain
mailaura domains dns <id> # Show DNS records to configure
mailaura domains verify <id> # Trigger DNS verification
mailaura domains mail-from <id> # Enable custom MAIL FROM
mailaura domains delete <id> --confirm # Delete a domainMedia
mailaura media list # List uploaded files
mailaura media get <id> # Show file details
mailaura media upload <file> # Upload a file
mailaura media delete <id> --confirm # Delete a file
mailaura media folders list # List media folders
mailaura media folders create --name "Images" # Create a folderAnalytics
mailaura analytics campaign <id> # Campaign performance stats
mailaura analytics list <id> # List growth analytics
mailaura analytics overview # Account-wide overviewBrand
mailaura brand get # Show brand settings
mailaura brand update # Update brand settings
mailaura brand colors # Show brand colorsAI Content
mailaura ai generate --prompt "..." # Generate email content with AI
mailaura ai subject --prompt "..." # Generate subject lines
mailaura ai improve --text "..." # Improve existing textLetters (Physical Mail via Pingen)
mailaura letters send # Send a physical letter via postal mail
mailaura letters list # List sent letters
mailaura letters get <id> # Show letter details & tracking
mailaura letters templates list # List letter templates
mailaura letters templates get <id> # Show template detailsProfile
mailaura profile get # Show account profile
mailaura profile usage # Show plan usage & limits
mailaura profile organization # Show organization detailsGlobal 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
mailaura --url http://localhost:3001 campaigns list
# or
export MAILAURA_API_URL=http://localhost:3001Also available
Mailaura is fully accessible for AI agents and LLMs:
- REST API — API Documentation
- MCP Server — MCP Integration
- CLI — This package
License
MIT © AdSimple GmbH
