CLI Commands Reference
Complete reference for all mailiam CLI commands, organized by functionality.
Core Commands
Section titled “Core Commands”mailiam init
Section titled “mailiam init”Initialize a new mailiam project with domain-based configuration.
mailiam init [domain] [options]Examples:
# Initialize with domainmailiam init mysite.com
# Initialize in specific directorymailiam init mysite.com --dir ./my-project
# Initialize with templatemailiam init mysite.com --template minimalOptions:
--dir <directory>- Target directory (default: current)--template <template>- Use configuration template--force- Override existing configuration--no-git- Skip git initialization
mailiam push
Section titled “mailiam push”Deploy configuration to mailiam infrastructure.
mailiam push [options]Examples:
# Deploy current configurationmailiam push
# Deploy with verbose outputmailiam push --verbose
# Dry run (preview changes)mailiam push --dry-run
# Deploy to specific environmentmailiam push --env stagingOptions:
--dry-run- Preview changes without deploying--env <environment>- Target environment--config <file>- Use specific config file--verbose- Detailed output--force- Force deployment even with warnings
mailiam pull
Section titled “mailiam pull”Sync remote configuration to local files.
mailiam pull [options]Examples:
# Pull latest configurationmailiam pull
# Pull specific environmentmailiam pull --env dev
# Force overwrite local changesmailiam pull --forceOptions:
--env <environment>- Source environment--force- Overwrite local changes--merge- Attempt to merge changes
mailiam status
Section titled “mailiam status”Check deployment status and configuration health.
mailiam status [options]Examples:
# Check overall statusmailiam status
# JSON output for scriptingmailiam status --output json
# Check specific domainmailiam status mysite.comOptions:
--output <format>- Output format (json, yaml, table)--detailed- Show detailed status information
Instant Forms
Section titled “Instant Forms”mailiam form
Section titled “mailiam form”Create an instant form endpoint with zero configuration.
mailiam form [options]Examples:
# Create instant formmailiam form# Returns: https://api.mailiam.dev/f/abc123def
# Create with custom settingsmailiam form --name "Contact Form" --email admin@mysite.com
# Create with spam protectionmailiam form --spam-protection strictOptions:
--name <name>- Form display name--email <email>- Notification email--spam-protection <level>- Protection level (strict, normal, lenient)--rate-limit <number>- Submissions per minute
mailiam setup
Section titled “mailiam setup”One-command setup for new domains with automatic DNS configuration.
mailiam setup <domain> [options]Examples:
# Complete domain setup with DNS syncmailiam setup mysite.com
# Setup with Cloudflare syncmailiam setup mysite.com --provider cloudflare
# Setup and configure SESmailiam setup mysite.com --enable-ses
# Setup with custom email settingsmailiam setup mysite.com --forwarding "hello@mysite.com:team@company.com"Options:
--provider <provider>- DNS provider for automatic sync--enable-ses- Configure AWS SES for custom sending--forwarding <rules>- Email forwarding rules (email:destination)--skip-dns- Skip DNS record creation--verify- Verify domain immediately after setup
mailiam instant
Section titled “mailiam instant”Manage instant forms (Formspree-style forms).
mailiam instant <command> [options]mailiam instant create
Section titled “mailiam instant create”Create a new instant form endpoint.
mailiam instant create [options]Examples:
# Create instant form interactivelymailiam instant create
# Create with specific settingsmailiam instant create \ --name "Contact Form" \ --email "contact@example.com" \ --honeypot "custom_honeypot"
# Create with custom message and acknowledgmentmailiam instant create \ --name "Newsletter Signup" \ --email "marketing@example.com" \ --custom-message "Thanks for signing up!" \ --acknowledgmentOptions:
--name <name>- Form display name--email <email>- Notification email address--honeypot <field>- Custom honeypot field name--rate-limit <number>- Submissions per hour (default: 10)--custom-message <message>- Custom success message--acknowledgment- Send acknowledgment emails to submitters--captcha- Enable CAPTCHA protection
mailiam instant list
Section titled “mailiam instant list”List your instant forms.
mailiam instant list [options]Examples:
# List all instant formsmailiam instant list
# Show detailed informationmailiam instant list --detailed
# Show security statusmailiam instant list --security
# JSON outputmailiam instant list --output jsonOptions:
--detailed- Show detailed form information--security- Include security status and stats--output <format>- Output format (table, json, yaml)
mailiam instant submissions
Section titled “mailiam instant submissions”View form submissions for an instant form.
mailiam instant submissions <formId> [options]Examples:
# View recent submissionsmailiam instant submissions form_abc123
# View submissions from last 24 hoursmailiam instant submissions form_abc123 --since 24h
# View with spam attemptsmailiam instant submissions form_abc123 --include-spam
# Export submissions to CSVmailiam instant submissions form_abc123 --format csv --output submissions.csv
# Live monitoringmailiam instant submissions form_abc123 --liveOptions:
--since <duration>- Time range (1h, 24h, 7d, 30d)--limit <number>- Maximum number of submissions--include-spam- Include blocked spam attempts--format <format>- Output format (table, json, csv)--output <file>- Save to file--live- Monitor submissions in real-time
mailiam instant claim
Section titled “mailiam instant claim”Claim an anonymous instant form with your email.
mailiam instant claim <formId> <email> [options]Examples:
# Claim form with your emailmailiam instant claim form_abc123 your@email.com
# Claim and set custom namemailiam instant claim form_abc123 your@email.com --name "My Contact Form"Options:
--name <name>- Set form display name--transfer- Transfer ownership completely
mailiam instant security
Section titled “mailiam instant security”Generate security report for an instant form.
mailiam instant security <formId> [options]Examples:
# Generate security reportmailiam instant security form_abc123
# Detailed security analysismailiam instant security form_abc123 --detailed
# Export security reportmailiam instant security form_abc123 --format json --output security-report.jsonOptions:
--detailed- Include detailed security metrics--format <format>- Report format (text, json, html)--output <file>- Save report to file
mailiam forms
Section titled “mailiam forms”Manage project-based forms.
mailiam forms <command> [options]mailiam forms list
Section titled “mailiam forms list”List all forms in current project.
mailiam forms list [options]Examples:
# List all formsmailiam forms list
# JSON outputmailiam forms list --output json
# Filter by domainmailiam forms list --domain mysite.commailiam forms show
Section titled “mailiam forms show”Show detailed form configuration.
mailiam forms show <form-name> [options]Examples:
# Show form detailsmailiam forms show contact
# Show form with endpointsmailiam forms show contact --include-endpoints
# JSON outputmailiam forms show contact --output jsonmailiam forms test
Section titled “mailiam forms test”Test form submission with sample data.
mailiam forms test <form-name> [options]Examples:
# Test with inline datamailiam forms test contact --data '{"email":"test@test.com","message":"test"}'
# Test with filemailiam forms test contact --data-file test.json
# Test form endpoint directlymailiam forms test https://api.mailiam.dev/f/abc123def --data-file test.jsonOptions:
--data <json>- JSON data for test submission--data-file <file>- File containing test data--verbose- Show full response details
Collections
Section titled “Collections”mailiam collections
Section titled “mailiam collections”Manage form collections for organizing multiple forms.
mailiam collections <command> [options]mailiam collections create
Section titled “mailiam collections create”Create a new collection.
mailiam collections create <slug> <name> [options]Examples:
# Create basic collectionmailiam collections create "support" "Support Forms"
# Create with description and settingsmailiam collections create "marketing" "Marketing Forms" \ --description "All marketing-related forms" \ --rate-limit 200 \ --spam-protection strictOptions:
--description <desc>- Collection description--rate-limit <number>- Rate limit for all forms--spam-protection <level>- Protection level--require-api-key- Require API key for submissions
mailiam collections list
Section titled “mailiam collections list”List all collections.
mailiam collections list [options]Examples:
# List collectionsmailiam collections list
# Show form countsmailiam collections list --include-counts
# JSON outputmailiam collections list --output jsonmailiam collections show
Section titled “mailiam collections show”Show detailed collection information.
mailiam collections show <slug> [options]Examples:
# Show collection detailsmailiam collections show support
# Include all forms in collectionmailiam collections show support --include-forms
# Show with endpointsmailiam collections show support --include-endpointsmailiam collections add-form
Section titled “mailiam collections add-form”Add a form to a collection.
mailiam collections add-form <collection-slug> <form-slug> <name> [options]Examples:
# Add form to collectionmailiam collections add-form "support" "technical" "Technical Support"
# Add with custom emailmailiam collections add-form "support" "billing" "Billing Questions" \ --email billing@company.com
# Add with custom settingsmailiam collections add-form "support" "urgent" "Urgent Issues" \ --email urgent@company.com \ --rate-limit 5 \ --custom-message "We'll respond within 1 hour!"Options:
--email <email>- Notification email--rate-limit <number>- Form-specific rate limit--custom-message <message>- Success message--template <template>- Email template
mailiam collections import
Section titled “mailiam collections import”Import an existing instant form into a collection.
mailiam collections import <collection-slug> <form-id> <form-slug> [options]Examples:
# Import instant formmailiam collections import "company" "abc123def" "contact"
# Import with new namemailiam collections import "company" "abc123def" "support" \ --name "Customer Support"Options:
--name <name>- Form display name--keep-original- Keep original instant form active
mailiam collections remove-form
Section titled “mailiam collections remove-form”Remove a form from a collection.
mailiam collections remove-form <collection-slug> <form-slug> [options]Examples:
# Remove form from collectionmailiam collections remove-form "support" "old-form"
# Force removal without confirmationmailiam collections remove-form "support" "old-form" --forcemailiam collections delete
Section titled “mailiam collections delete”Delete an entire collection.
mailiam collections delete <slug> [options]Examples:
# Delete collection (requires confirmation)mailiam collections delete old-collection
# Force deletionmailiam collections delete old-collection --forceOptions:
--force- Skip confirmation prompt
Domain Management
Section titled “Domain Management”mailiam domains
Section titled “mailiam domains”Manage custom domains and DNS configuration.
mailiam domains <command> [options]mailiam domains list
Section titled “mailiam domains list”List all configured domains.
mailiam domains list [options]Examples:
# List all domainsmailiam domains list
# Show verification statusmailiam domains list --status
# JSON outputmailiam domains list --output jsonmailiam domains add
Section titled “mailiam domains add”Add a new domain to your account.
mailiam domains add <domain> [options]Examples:
# Add domainmailiam domains add mysite.com
# Add with immediate verification attemptmailiam domains add mysite.com --verify
# Add subdomainmailiam domains add api.mysite.com --type subdomainOptions:
--verify- Attempt verification immediately--type <type>- Domain type (domain, subdomain)
mailiam domains verify
Section titled “mailiam domains verify”Verify domain ownership.
mailiam domains verify <domain> [options]Examples:
# Verify domainmailiam domains verify mysite.com
# Force re-verificationmailiam domains verify mysite.com --force
# Check verification statusmailiam domains verify mysite.com --check-onlyOptions:
--force- Force re-verification--check-only- Check status without attempting verification
mailiam domains dns-config
Section titled “mailiam domains dns-config”Get DNS configuration for a domain.
mailiam domains dns-config <domain> [options]Examples:
# Get DNS recordsmailiam domains dns-config mysite.com
# Get records in bind formatmailiam domains dns-config mysite.com --format bind
# Get only MX recordsmailiam domains dns-config mysite.com --type mxOptions:
--format <format>- Output format (json, bind, table)--type <type>- Record type (mx, txt, cname, all)
mailiam domains setup
Section titled “mailiam domains setup”Set up DNS records for configured domains with automated DNS sync support.
mailiam domains setup [domain] [options]Examples:
# Set up DNS for all configured domainsmailiam domains setup
# Set up specific domainmailiam domains setup mysite.com
# Save DNS records locally for syncmailiam domains setup mysite.com --save
# Get DNS records in different formatsmailiam domains setup mysite.com --format jsonOptions:
--save- Save DNS records locally for syncing to DNS providers--format <format>- Output format (json, table, bind)--verbose- Show detailed setup information
mailiam domains sync
Section titled “mailiam domains sync”Sync DNS records to your DNS provider (requires saved records).
mailiam domains sync <domain> [options]Examples:
# Sync DNS records to Cloudflaremailiam domains sync mysite.com --provider cloudflare
# Dry run to preview changesmailiam domains sync mysite.com --provider cloudflare --dry-run
# Force sync and delete records not in local storagemailiam domains sync mysite.com --provider cloudflare --forceOptions:
--provider <provider>- DNS provider (currently: cloudflare)--dry-run- Preview changes without applying them--force- Delete DNS records not present in local storage
mailiam domains sync-status
Section titled “mailiam domains sync-status”Show DNS synchronization status for domains.
mailiam domains sync-status [domain] [options]Examples:
# Show sync status for all domainsmailiam domains sync-status
# Show sync status for specific domainmailiam domains sync-status mysite.com
# Include detailed sync historymailiam domains sync-status mysite.com --detailedmailiam domains list-stored
Section titled “mailiam domains list-stored”List locally stored DNS records.
mailiam domains list-stored [options]Examples:
# List all stored DNS recordsmailiam domains list-stored
# Show record countsmailiam domains list-stored --counts
# JSON output for scriptingmailiam domains list-stored --output jsonmailiam domains export
Section titled “mailiam domains export”Export DNS records in various formats.
mailiam domains export <domain> [options]Examples:
# Export as JSONmailiam domains export mysite.com --format json
# Export as BIND zone filemailiam domains export mysite.com --format bind
# Save to filemailiam domains export mysite.com --format json --output mysite-dns.jsonOptions:
--format <format>- Export format (json, bind, csv)--output <file>- Output file path
mailiam domains ses-status
Section titled “mailiam domains ses-status”Check AWS SES verification status for custom sending.
mailiam domains ses-status <domain> [options]Examples:
# Check SES verification statusmailiam domains ses-status mysite.com
# Force refresh status from AWSmailiam domains ses-status mysite.com --refresh
# Show detailed SES informationmailiam domains ses-status mysite.com --detailedmailiam domains verify-ses
Section titled “mailiam domains verify-ses”Initiate AWS SES domain verification process.
mailiam domains verify-ses <domain> [options]Examples:
# Start SES verificationmailiam domains verify-ses mysite.com
# Get verification DNS recordmailiam domains verify-ses mysite.com --get-recordmailiam domains setup-dkim
Section titled “mailiam domains setup-dkim”Get DKIM DNS records for email authentication.
mailiam domains setup-dkim <domain> [options]Examples:
# Get DKIM records (requires SES verification)mailiam domains setup-dkim mysite.com
# Save DKIM records locallymailiam domains setup-dkim mysite.com --savemailiam domains verify-dkim
Section titled “mailiam domains verify-dkim”Check DKIM verification status.
mailiam domains verify-dkim <domain> [options]Examples:
# Check DKIM verificationmailiam domains verify-dkim mysite.com
# Force verification checkmailiam domains verify-dkim mysite.com --forcemailiam domains setup-spf
Section titled “mailiam domains setup-spf”Get SPF DNS record for email authentication.
mailiam domains setup-spf <domain> [options]Examples:
# Get SPF recordmailiam domains setup-spf mysite.com
# Include additional serversmailiam domains setup-spf mysite.com --include "include:_spf.example.com"mailiam domains setup-dmarc
Section titled “mailiam domains setup-dmarc”Get DMARC DNS record for email authentication.
mailiam domains setup-dmarc <domain> [options]Examples:
# Get basic DMARC recordmailiam domains setup-dmarc mysite.com
# Set policy to rejectmailiam domains setup-dmarc mysite.com --policy reject
# Add reporting addressesmailiam domains setup-dmarc mysite.com --rua "mailto:dmarc@mysite.com"mailiam domains test
Section titled “mailiam domains test”Test domain configuration and email routing.
mailiam domains test <domain> [email] [options]Examples:
# Test domain setupmailiam domains test mysite.com
# Test email routingmailiam domains test mysite.com test@mysite.com
# Test multiple addressesmailiam domains test mysite.com support@mysite.com sales@mysite.comOptions:
--verbose- Show detailed test results--check-dns- Include DNS propagation check
DNS Provider Management
Section titled “DNS Provider Management”mailiam providers
Section titled “mailiam providers”Manage DNS provider credentials for automated DNS sync.
mailiam providers <command> [options]mailiam providers add
Section titled “mailiam providers add”Add DNS provider credentials.
mailiam providers add <provider> [options]Examples:
# Add Cloudflare provider (interactive)mailiam providers add cloudflare
# Add with API token directlymailiam providers add cloudflare --api-token "your-cloudflare-api-token"
# Add with zone restrictionmailiam providers add cloudflare --zones "example.com,api.example.com"Options:
--api-token <token>- API token for provider authentication--zones <zones>- Comma-separated list of zones this token can access--name <name>- Custom name for this provider configuration
mailiam providers list
Section titled “mailiam providers list”List configured DNS providers.
mailiam providers list [options]Examples:
# List all providersmailiam providers list
# Show provider detailsmailiam providers list --detailed
# JSON outputmailiam providers list --output jsonmailiam providers test
Section titled “mailiam providers test”Test DNS provider connection and permissions.
mailiam providers test <provider> [options]Examples:
# Test Cloudflare connectionmailiam providers test cloudflare
# Test with specific zonemailiam providers test cloudflare --zone example.com
# Verbose testingmailiam providers test cloudflare --verboseOptions:
--zone <zone>- Test access to specific zone--verbose- Show detailed test results
mailiam providers remove
Section titled “mailiam providers remove”Remove DNS provider credentials.
mailiam providers remove <provider> [options]Examples:
# Remove provider (requires confirmation)mailiam providers remove cloudflare
# Force removal without confirmationmailiam providers remove cloudflare --forceOptions:
--force- Skip confirmation prompt
mailiam providers export
Section titled “mailiam providers export”Export provider configuration for backup.
mailiam providers export [options]Examples:
# Export all provider configs (tokens will be masked)mailiam providers export
# Export to filemailiam providers export --output providers-backup.json
# Export specific providermailiam providers export --provider cloudflareOptions:
--output <file>- Output file path--provider <provider>- Export specific provider only--include-tokens- Include API tokens (use with caution)
Configuration Management
Section titled “Configuration Management”mailiam config
Section titled “mailiam config”Manage CLI configuration and settings.
mailiam config <command> [options]mailiam config list
Section titled “mailiam config list”Show current configuration.
# Show all configmailiam config list
# Show specific keymailiam config list apiKeymailiam config set
Section titled “mailiam config set”Set configuration values.
mailiam config set <key> <value>Examples:
# Set API keymailiam config set apiKey sk-abc123def
# Set editormailiam config set editor vim
# Set default regionmailiam config set region us-east-1mailiam config validate
Section titled “mailiam config validate”Validate configuration file syntax.
mailiam config validate [file] [options]Examples:
# Validate current configmailiam config validate
# Validate specific filemailiam config validate mailiam.config.staging.yaml
# Strict validationmailiam config validate --strictOptions:
--strict- Enable strict validation mode--schema-version <version>- Use specific schema version
Testing Utilities
Section titled “Testing Utilities”mailiam test
Section titled “mailiam test”Testing utilities for validating your mailiam setup.
mailiam test <command> [options]mailiam test send
Section titled “mailiam test send”Send a test email to verify email delivery.
mailiam test send [email] [options]Examples:
# Send test email to yourselfmailiam test send
# Send to specific addressmailiam test send admin@example.com
# Send with custom messagemailiam test send admin@example.com --message "Testing email delivery"
# Send using specific domainmailiam test send admin@example.com --from contact@mysite.comOptions:
--message <message>- Custom test message--from <address>- Send from specific address--subject <subject>- Custom subject line
mailiam test config
Section titled “mailiam test config”Validate configuration file and setup.
mailiam test config [options]Examples:
# Validate current configurationmailiam test config
# Validate specific config filemailiam test config --file staging.yaml
# Strict validation with warningsmailiam test config --strict
# Check API connectivitymailiam test config --check-apiOptions:
--file <file>- Specific configuration file to validate--strict- Enable strict validation mode--check-api- Test API connectivity and permissions
Authentication
Section titled “Authentication”mailiam signup
Section titled “mailiam signup”Create a new mailiam account.
mailiam signup [options]Examples:
# Interactive signupmailiam signup
# Signup with specific planmailiam signup --plan starter
# Signup for organizationmailiam signup --org "My Company"Options:
--plan <plan>- Subscription plan (free, starter, pro)--org <name>- Organization name
mailiam auth
Section titled “mailiam auth”Manage authentication and API keys.
mailiam auth <command> [options]mailiam auth set-key
Section titled “mailiam auth set-key”Set your API key.
mailiam auth set-key <api-key> [options]Examples:
# Set API key globallymailiam auth set-key mlm_sk_live_abc123...
# Set for specific profilemailiam auth set-key mlm_sk_test_xyz789... --profile development
# Set with custom endpointmailiam auth set-key mlm_sk_live_abc123... --endpoint https://api.mailiam.devOptions:
--profile <name>- Configuration profile name--endpoint <url>- API endpoint URL
mailiam auth status
Section titled “mailiam auth status”Check authentication status and API key information.
mailiam auth status [options]Examples:
# Check current auth statusmailiam auth status
# Show detailed informationmailiam auth status --detailed
# Check specific profilemailiam auth status --profile productionOptions:
--detailed- Show detailed authentication information--profile <name>- Check specific profile
mailiam auth clear
Section titled “mailiam auth clear”Remove stored authentication credentials.
mailiam auth clear [options]Examples:
# Clear current credentialsmailiam auth clear
# Clear specific profilemailiam auth clear --profile staging
# Clear all profilesmailiam auth clear --allOptions:
--profile <name>- Clear specific profile--all- Clear all stored credentials
Monitoring and Debugging
Section titled “Monitoring and Debugging”mailiam logs
Section titled “mailiam logs”View application logs and events.
mailiam logs [type] [options]Examples:
# View all recent logsmailiam logs --last 1h
# View form submission logsmailiam logs forms --last 24h
# View specific form logsmailiam logs forms contact --last 6h
# Follow logs in real-timemailiam logs --follow
# Filter by levelmailiam logs --level error --last 1dOptions:
--last <duration>- Time range (1h, 24h, 7d, etc.)--level <level>- Log level (debug, info, warn, error)--follow- Follow logs in real-time--output <format>- Output format (text, json)
mailiam metrics
Section titled “mailiam metrics”View performance and usage metrics.
mailiam metrics [type] [options]Examples:
# Overall metricsmailiam metrics --last 7d
# Form submission metricsmailiam metrics forms --last 30d
# Response time metricsmailiam metrics performance --last 24h
# Error rate metricsmailiam metrics errors --last 1dmailiam health-check
Section titled “mailiam health-check”Run comprehensive health checks.
mailiam health-check [options]Examples:
# Run all health checksmailiam health-check
# Check specific componentsmailiam health-check --component forms
# Verbose outputmailiam health-check --verboseBilling & Usage
Section titled “Billing & Usage”mailiam upgrade
Section titled “mailiam upgrade”Upgrade your mailiam subscription to Pro or Agency.
mailiam upgrade [options]Examples:
# Interactive upgrademailiam upgrade
# Upgrade to Pro planmailiam upgrade --plan pro
# Upgrade to Agency planmailiam upgrade --plan agencyOptions:
--plan <plan>- Target plan (pro, agency)
mailiam usage
Section titled “mailiam usage”Check your current email usage and quota status.
mailiam usage [options]Examples:
# View current usagemailiam usage
# Show detailed usage breakdownmailiam usage --detailed
# JSON output for scriptingmailiam usage --output jsonOptions:
--detailed- Show detailed usage breakdown by form/domain--output <format>- Output format (table, json)
mailiam billing
Section titled “mailiam billing”Manage billing and subscription.
mailiam billing <command> [options]Examples:
# View billing statusmailiam billing status
# Open customer portalmailiam billing portal
# View billing historymailiam billing historyReply Identity & Signatures
Section titled “Reply Identity & Signatures”mailiam reply
Section titled “mailiam reply”Manage reply identity preservation (SRS). This feature allows recipients to reply to forwarded emails while maintaining your domain’s identity.
mailiam reply <command> [options]Examples:
# Check reply identity statusmailiam reply status
# Enable reply identity for a domainmailiam reply enable example.com
# Configure authorized sendersmailiam reply authorize example.com sender@gmail.commailiam reply-quick-setup
Section titled “mailiam reply-quick-setup”Quick setup for reply identity with authorized sender.
mailiam reply-quick-setup <domain> <email>Examples:
# Quick setup reply identitymailiam reply-quick-setup mysite.com me@gmail.commailiam signatures
Section titled “mailiam signatures”Manage email signatures for SRS replies.
mailiam signatures <command> [options]Examples:
# List configured signaturesmailiam signatures list
# Create a new signaturemailiam signatures create "professional" --template professional
# Show signature detailsmailiam signatures show professional
# Delete a signaturemailiam signatures delete old-signatureAPI Keys
Section titled “API Keys”mailiam apikeys
Section titled “mailiam apikeys”Manage API keys for programmatic access.
mailiam apikeys <command> [options]Examples:
# List all API keysmailiam apikeys list
# Create a new public keymailiam apikeys create --name "Website Forms" --type public --domain mysite.com
# Create a usage keymailiam apikeys create --name "Backend API" --type usage
# Revoke an API keymailiam apikeys revoke mlm_pk_abc123...Key Types:
public(mlm_pk_*) - Client-safe, domain-scoped, 100 req/hourusage(mlm_sk_*) - Server-side, 1000 req/houradmin(mlm_sk_admin_*) - Full access, 10000 req/houragent(mlm_agent_*) - AI/MCP integrations, 5000 req/hour
Utility Commands
Section titled “Utility Commands”mailiam version
Section titled “mailiam version”Show version information.
mailiam version [options]Options:
--verbose- Show detailed version information
mailiam help
Section titled “mailiam help”Show help information.
# General helpmailiam help
# Command-specific helpmailiam help forms
# Show examplesmailiam help forms --examplesmailiam completion
Section titled “mailiam completion”Generate shell completion scripts.
# Bash completionmailiam completion bash >> ~/.bashrc
# Zsh completionmailiam completion zsh >> ~/.zshrc
# Fish completionmailiam completion fish >> ~/.config/fish/completions/mailiam.fishGlobal Options
Section titled “Global Options”These options work with most commands:
--verbose- Enable verbose output--quiet- Minimal output--output <format>- Output format (json, yaml, table)--config <file>- Use specific config file--env <environment>- Target environment--api-key <key>- Override API key--help- Show command help
Exit Codes
Section titled “Exit Codes”The CLI uses standard exit codes:
0- Success1- General error2- Configuration error3- Authentication error4- Network error5- Validation error
Examples by Use Case
Section titled “Examples by Use Case”Setting up a new website
Section titled “Setting up a new website”# 1. Initializemailiam init mysite.comcd mysite.com
# 2. Configure domainvim mailiam.config.yaml
# 3. Deploymailiam push
# 4. Verifymailiam domains verify mysite.commailiam statusCreating a form collection
Section titled “Creating a form collection”# 1. Create collectionmailiam collections create "support" "Support Forms"
# 2. Add formsmailiam collections add-form "support" "technical" "Technical Support"mailiam collections add-form "support" "billing" "Billing Questions"
# 3. Deploymailiam push
# 4. Testmailiam forms test support/technical --data '{"email":"test@test.com","message":"test"}'Migrating an instant form
Section titled “Migrating an instant form”# 1. List existing formsmailiam forms list
# 2. Create collectionmailiam collections create "company" "Company Forms"
# 3. Import formmailiam collections import "company" "abc123def" "contact"
# 4. Deploymailiam push
# 5. Update your HTML to use new endpoint:# https://api.mailiam.dev/f/company/contactThe mailiam CLI provides powerful, intuitive commands for every aspect of email infrastructure management.