Skip to content

CLI Commands Reference

Complete reference for all mailiam CLI commands, organized by functionality.

Initialize a new mailiam project with domain-based configuration.

Terminal window
mailiam init [domain] [options]

Examples:

Terminal window
# Initialize with domain
mailiam init mysite.com
# Initialize in specific directory
mailiam init mysite.com --dir ./my-project
# Initialize with template
mailiam init mysite.com --template minimal

Options:

  • --dir <directory> - Target directory (default: current)
  • --template <template> - Use configuration template
  • --force - Override existing configuration
  • --no-git - Skip git initialization

Deploy configuration to mailiam infrastructure.

Terminal window
mailiam push [options]

Examples:

Terminal window
# Deploy current configuration
mailiam push
# Deploy with verbose output
mailiam push --verbose
# Dry run (preview changes)
mailiam push --dry-run
# Deploy to specific environment
mailiam push --env staging

Options:

  • --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

Sync remote configuration to local files.

Terminal window
mailiam pull [options]

Examples:

Terminal window
# Pull latest configuration
mailiam pull
# Pull specific environment
mailiam pull --env dev
# Force overwrite local changes
mailiam pull --force

Options:

  • --env <environment> - Source environment
  • --force - Overwrite local changes
  • --merge - Attempt to merge changes

Check deployment status and configuration health.

Terminal window
mailiam status [options]

Examples:

Terminal window
# Check overall status
mailiam status
# JSON output for scripting
mailiam status --output json
# Check specific domain
mailiam status mysite.com

Options:

  • --output <format> - Output format (json, yaml, table)
  • --detailed - Show detailed status information

Create an instant form endpoint with zero configuration.

Terminal window
mailiam form [options]

Examples:

Terminal window
# Create instant form
mailiam form
# Returns: https://api.mailiam.dev/f/abc123def
# Create with custom settings
mailiam form --name "Contact Form" --email admin@mysite.com
# Create with spam protection
mailiam form --spam-protection strict

Options:

  • --name <name> - Form display name
  • --email <email> - Notification email
  • --spam-protection <level> - Protection level (strict, normal, lenient)
  • --rate-limit <number> - Submissions per minute

One-command setup for new domains with automatic DNS configuration.

Terminal window
mailiam setup <domain> [options]

Examples:

Terminal window
# Complete domain setup with DNS sync
mailiam setup mysite.com
# Setup with Cloudflare sync
mailiam setup mysite.com --provider cloudflare
# Setup and configure SES
mailiam setup mysite.com --enable-ses
# Setup with custom email settings
mailiam 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

Manage instant forms (Formspree-style forms).

Terminal window
mailiam instant <command> [options]

Create a new instant form endpoint.

Terminal window
mailiam instant create [options]

Examples:

Terminal window
# Create instant form interactively
mailiam instant create
# Create with specific settings
mailiam instant create \
--name "Contact Form" \
--email "contact@example.com" \
--honeypot "custom_honeypot"
# Create with custom message and acknowledgment
mailiam instant create \
--name "Newsletter Signup" \
--email "marketing@example.com" \
--custom-message "Thanks for signing up!" \
--acknowledgment

Options:

  • --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

List your instant forms.

Terminal window
mailiam instant list [options]

Examples:

Terminal window
# List all instant forms
mailiam instant list
# Show detailed information
mailiam instant list --detailed
# Show security status
mailiam instant list --security
# JSON output
mailiam instant list --output json

Options:

  • --detailed - Show detailed form information
  • --security - Include security status and stats
  • --output <format> - Output format (table, json, yaml)

View form submissions for an instant form.

Terminal window
mailiam instant submissions <formId> [options]

Examples:

Terminal window
# View recent submissions
mailiam instant submissions form_abc123
# View submissions from last 24 hours
mailiam instant submissions form_abc123 --since 24h
# View with spam attempts
mailiam instant submissions form_abc123 --include-spam
# Export submissions to CSV
mailiam instant submissions form_abc123 --format csv --output submissions.csv
# Live monitoring
mailiam instant submissions form_abc123 --live

Options:

  • --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

Claim an anonymous instant form with your email.

Terminal window
mailiam instant claim <formId> <email> [options]

Examples:

Terminal window
# Claim form with your email
mailiam instant claim form_abc123 your@email.com
# Claim and set custom name
mailiam instant claim form_abc123 your@email.com --name "My Contact Form"

Options:

  • --name <name> - Set form display name
  • --transfer - Transfer ownership completely

Generate security report for an instant form.

Terminal window
mailiam instant security <formId> [options]

Examples:

Terminal window
# Generate security report
mailiam instant security form_abc123
# Detailed security analysis
mailiam instant security form_abc123 --detailed
# Export security report
mailiam instant security form_abc123 --format json --output security-report.json

Options:

  • --detailed - Include detailed security metrics
  • --format <format> - Report format (text, json, html)
  • --output <file> - Save report to file

Manage project-based forms.

Terminal window
mailiam forms <command> [options]

List all forms in current project.

Terminal window
mailiam forms list [options]

Examples:

Terminal window
# List all forms
mailiam forms list
# JSON output
mailiam forms list --output json
# Filter by domain
mailiam forms list --domain mysite.com

Show detailed form configuration.

Terminal window
mailiam forms show <form-name> [options]

Examples:

Terminal window
# Show form details
mailiam forms show contact
# Show form with endpoints
mailiam forms show contact --include-endpoints
# JSON output
mailiam forms show contact --output json

Test form submission with sample data.

Terminal window
mailiam forms test <form-name> [options]

Examples:

Terminal window
# Test with inline data
mailiam forms test contact --data '{"email":"test@test.com","message":"test"}'
# Test with file
mailiam forms test contact --data-file test.json
# Test form endpoint directly
mailiam forms test https://api.mailiam.dev/f/abc123def --data-file test.json

Options:

  • --data <json> - JSON data for test submission
  • --data-file <file> - File containing test data
  • --verbose - Show full response details

Manage form collections for organizing multiple forms.

Terminal window
mailiam collections <command> [options]

Create a new collection.

Terminal window
mailiam collections create <slug> <name> [options]

Examples:

Terminal window
# Create basic collection
mailiam collections create "support" "Support Forms"
# Create with description and settings
mailiam collections create "marketing" "Marketing Forms" \
--description "All marketing-related forms" \
--rate-limit 200 \
--spam-protection strict

Options:

  • --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

List all collections.

Terminal window
mailiam collections list [options]

Examples:

Terminal window
# List collections
mailiam collections list
# Show form counts
mailiam collections list --include-counts
# JSON output
mailiam collections list --output json

Show detailed collection information.

Terminal window
mailiam collections show <slug> [options]

Examples:

Terminal window
# Show collection details
mailiam collections show support
# Include all forms in collection
mailiam collections show support --include-forms
# Show with endpoints
mailiam collections show support --include-endpoints

Add a form to a collection.

Terminal window
mailiam collections add-form <collection-slug> <form-slug> <name> [options]

Examples:

Terminal window
# Add form to collection
mailiam collections add-form "support" "technical" "Technical Support"
# Add with custom email
mailiam collections add-form "support" "billing" "Billing Questions" \
--email billing@company.com
# Add with custom settings
mailiam 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

Import an existing instant form into a collection.

Terminal window
mailiam collections import <collection-slug> <form-id> <form-slug> [options]

Examples:

Terminal window
# Import instant form
mailiam collections import "company" "abc123def" "contact"
# Import with new name
mailiam collections import "company" "abc123def" "support" \
--name "Customer Support"

Options:

  • --name <name> - Form display name
  • --keep-original - Keep original instant form active

Remove a form from a collection.

Terminal window
mailiam collections remove-form <collection-slug> <form-slug> [options]

Examples:

Terminal window
# Remove form from collection
mailiam collections remove-form "support" "old-form"
# Force removal without confirmation
mailiam collections remove-form "support" "old-form" --force

Delete an entire collection.

Terminal window
mailiam collections delete <slug> [options]

Examples:

Terminal window
# Delete collection (requires confirmation)
mailiam collections delete old-collection
# Force deletion
mailiam collections delete old-collection --force

Options:

  • --force - Skip confirmation prompt

Manage custom domains and DNS configuration.

Terminal window
mailiam domains <command> [options]

List all configured domains.

Terminal window
mailiam domains list [options]

Examples:

Terminal window
# List all domains
mailiam domains list
# Show verification status
mailiam domains list --status
# JSON output
mailiam domains list --output json

Add a new domain to your account.

Terminal window
mailiam domains add <domain> [options]

Examples:

Terminal window
# Add domain
mailiam domains add mysite.com
# Add with immediate verification attempt
mailiam domains add mysite.com --verify
# Add subdomain
mailiam domains add api.mysite.com --type subdomain

Options:

  • --verify - Attempt verification immediately
  • --type <type> - Domain type (domain, subdomain)

Verify domain ownership.

Terminal window
mailiam domains verify <domain> [options]

Examples:

Terminal window
# Verify domain
mailiam domains verify mysite.com
# Force re-verification
mailiam domains verify mysite.com --force
# Check verification status
mailiam domains verify mysite.com --check-only

Options:

  • --force - Force re-verification
  • --check-only - Check status without attempting verification

Get DNS configuration for a domain.

Terminal window
mailiam domains dns-config <domain> [options]

Examples:

Terminal window
# Get DNS records
mailiam domains dns-config mysite.com
# Get records in bind format
mailiam domains dns-config mysite.com --format bind
# Get only MX records
mailiam domains dns-config mysite.com --type mx

Options:

  • --format <format> - Output format (json, bind, table)
  • --type <type> - Record type (mx, txt, cname, all)

Set up DNS records for configured domains with automated DNS sync support.

Terminal window
mailiam domains setup [domain] [options]

Examples:

Terminal window
# Set up DNS for all configured domains
mailiam domains setup
# Set up specific domain
mailiam domains setup mysite.com
# Save DNS records locally for sync
mailiam domains setup mysite.com --save
# Get DNS records in different formats
mailiam domains setup mysite.com --format json

Options:

  • --save - Save DNS records locally for syncing to DNS providers
  • --format <format> - Output format (json, table, bind)
  • --verbose - Show detailed setup information

Sync DNS records to your DNS provider (requires saved records).

Terminal window
mailiam domains sync <domain> [options]

Examples:

Terminal window
# Sync DNS records to Cloudflare
mailiam domains sync mysite.com --provider cloudflare
# Dry run to preview changes
mailiam domains sync mysite.com --provider cloudflare --dry-run
# Force sync and delete records not in local storage
mailiam domains sync mysite.com --provider cloudflare --force

Options:

  • --provider <provider> - DNS provider (currently: cloudflare)
  • --dry-run - Preview changes without applying them
  • --force - Delete DNS records not present in local storage

Show DNS synchronization status for domains.

Terminal window
mailiam domains sync-status [domain] [options]

Examples:

Terminal window
# Show sync status for all domains
mailiam domains sync-status
# Show sync status for specific domain
mailiam domains sync-status mysite.com
# Include detailed sync history
mailiam domains sync-status mysite.com --detailed

List locally stored DNS records.

Terminal window
mailiam domains list-stored [options]

Examples:

Terminal window
# List all stored DNS records
mailiam domains list-stored
# Show record counts
mailiam domains list-stored --counts
# JSON output for scripting
mailiam domains list-stored --output json

Export DNS records in various formats.

Terminal window
mailiam domains export <domain> [options]

Examples:

Terminal window
# Export as JSON
mailiam domains export mysite.com --format json
# Export as BIND zone file
mailiam domains export mysite.com --format bind
# Save to file
mailiam domains export mysite.com --format json --output mysite-dns.json

Options:

  • --format <format> - Export format (json, bind, csv)
  • --output <file> - Output file path

Check AWS SES verification status for custom sending.

Terminal window
mailiam domains ses-status <domain> [options]

Examples:

Terminal window
# Check SES verification status
mailiam domains ses-status mysite.com
# Force refresh status from AWS
mailiam domains ses-status mysite.com --refresh
# Show detailed SES information
mailiam domains ses-status mysite.com --detailed

Initiate AWS SES domain verification process.

Terminal window
mailiam domains verify-ses <domain> [options]

Examples:

Terminal window
# Start SES verification
mailiam domains verify-ses mysite.com
# Get verification DNS record
mailiam domains verify-ses mysite.com --get-record

Get DKIM DNS records for email authentication.

Terminal window
mailiam domains setup-dkim <domain> [options]

Examples:

Terminal window
# Get DKIM records (requires SES verification)
mailiam domains setup-dkim mysite.com
# Save DKIM records locally
mailiam domains setup-dkim mysite.com --save

Check DKIM verification status.

Terminal window
mailiam domains verify-dkim <domain> [options]

Examples:

Terminal window
# Check DKIM verification
mailiam domains verify-dkim mysite.com
# Force verification check
mailiam domains verify-dkim mysite.com --force

Get SPF DNS record for email authentication.

Terminal window
mailiam domains setup-spf <domain> [options]

Examples:

Terminal window
# Get SPF record
mailiam domains setup-spf mysite.com
# Include additional servers
mailiam domains setup-spf mysite.com --include "include:_spf.example.com"

Get DMARC DNS record for email authentication.

Terminal window
mailiam domains setup-dmarc <domain> [options]

Examples:

Terminal window
# Get basic DMARC record
mailiam domains setup-dmarc mysite.com
# Set policy to reject
mailiam domains setup-dmarc mysite.com --policy reject
# Add reporting addresses
mailiam domains setup-dmarc mysite.com --rua "mailto:dmarc@mysite.com"

Test domain configuration and email routing.

Terminal window
mailiam domains test <domain> [email] [options]

Examples:

Terminal window
# Test domain setup
mailiam domains test mysite.com
# Test email routing
mailiam domains test mysite.com test@mysite.com
# Test multiple addresses
mailiam domains test mysite.com support@mysite.com sales@mysite.com

Options:

  • --verbose - Show detailed test results
  • --check-dns - Include DNS propagation check

Manage DNS provider credentials for automated DNS sync.

Terminal window
mailiam providers <command> [options]

Add DNS provider credentials.

Terminal window
mailiam providers add <provider> [options]

Examples:

Terminal window
# Add Cloudflare provider (interactive)
mailiam providers add cloudflare
# Add with API token directly
mailiam providers add cloudflare --api-token "your-cloudflare-api-token"
# Add with zone restriction
mailiam 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

List configured DNS providers.

Terminal window
mailiam providers list [options]

Examples:

Terminal window
# List all providers
mailiam providers list
# Show provider details
mailiam providers list --detailed
# JSON output
mailiam providers list --output json

Test DNS provider connection and permissions.

Terminal window
mailiam providers test <provider> [options]

Examples:

Terminal window
# Test Cloudflare connection
mailiam providers test cloudflare
# Test with specific zone
mailiam providers test cloudflare --zone example.com
# Verbose testing
mailiam providers test cloudflare --verbose

Options:

  • --zone <zone> - Test access to specific zone
  • --verbose - Show detailed test results

Remove DNS provider credentials.

Terminal window
mailiam providers remove <provider> [options]

Examples:

Terminal window
# Remove provider (requires confirmation)
mailiam providers remove cloudflare
# Force removal without confirmation
mailiam providers remove cloudflare --force

Options:

  • --force - Skip confirmation prompt

Export provider configuration for backup.

Terminal window
mailiam providers export [options]

Examples:

Terminal window
# Export all provider configs (tokens will be masked)
mailiam providers export
# Export to file
mailiam providers export --output providers-backup.json
# Export specific provider
mailiam providers export --provider cloudflare

Options:

  • --output <file> - Output file path
  • --provider <provider> - Export specific provider only
  • --include-tokens - Include API tokens (use with caution)

Manage CLI configuration and settings.

Terminal window
mailiam config <command> [options]

Show current configuration.

Terminal window
# Show all config
mailiam config list
# Show specific key
mailiam config list apiKey

Set configuration values.

Terminal window
mailiam config set <key> <value>

Examples:

Terminal window
# Set API key
mailiam config set apiKey sk-abc123def
# Set editor
mailiam config set editor vim
# Set default region
mailiam config set region us-east-1

Validate configuration file syntax.

Terminal window
mailiam config validate [file] [options]

Examples:

Terminal window
# Validate current config
mailiam config validate
# Validate specific file
mailiam config validate mailiam.config.staging.yaml
# Strict validation
mailiam config validate --strict

Options:

  • --strict - Enable strict validation mode
  • --schema-version <version> - Use specific schema version

Testing utilities for validating your mailiam setup.

Terminal window
mailiam test <command> [options]

Send a test email to verify email delivery.

Terminal window
mailiam test send [email] [options]

Examples:

Terminal window
# Send test email to yourself
mailiam test send
# Send to specific address
mailiam test send admin@example.com
# Send with custom message
mailiam test send admin@example.com --message "Testing email delivery"
# Send using specific domain
mailiam test send admin@example.com --from contact@mysite.com

Options:

  • --message <message> - Custom test message
  • --from <address> - Send from specific address
  • --subject <subject> - Custom subject line

Validate configuration file and setup.

Terminal window
mailiam test config [options]

Examples:

Terminal window
# Validate current configuration
mailiam test config
# Validate specific config file
mailiam test config --file staging.yaml
# Strict validation with warnings
mailiam test config --strict
# Check API connectivity
mailiam test config --check-api

Options:

  • --file <file> - Specific configuration file to validate
  • --strict - Enable strict validation mode
  • --check-api - Test API connectivity and permissions

Create a new mailiam account.

Terminal window
mailiam signup [options]

Examples:

Terminal window
# Interactive signup
mailiam signup
# Signup with specific plan
mailiam signup --plan starter
# Signup for organization
mailiam signup --org "My Company"

Options:

  • --plan <plan> - Subscription plan (free, starter, pro)
  • --org <name> - Organization name

Manage authentication and API keys.

Terminal window
mailiam auth <command> [options]

Set your API key.

Terminal window
mailiam auth set-key <api-key> [options]

Examples:

Terminal window
# Set API key globally
mailiam auth set-key mlm_sk_live_abc123...
# Set for specific profile
mailiam auth set-key mlm_sk_test_xyz789... --profile development
# Set with custom endpoint
mailiam auth set-key mlm_sk_live_abc123... --endpoint https://api.mailiam.dev

Options:

  • --profile <name> - Configuration profile name
  • --endpoint <url> - API endpoint URL

Check authentication status and API key information.

Terminal window
mailiam auth status [options]

Examples:

Terminal window
# Check current auth status
mailiam auth status
# Show detailed information
mailiam auth status --detailed
# Check specific profile
mailiam auth status --profile production

Options:

  • --detailed - Show detailed authentication information
  • --profile <name> - Check specific profile

Remove stored authentication credentials.

Terminal window
mailiam auth clear [options]

Examples:

Terminal window
# Clear current credentials
mailiam auth clear
# Clear specific profile
mailiam auth clear --profile staging
# Clear all profiles
mailiam auth clear --all

Options:

  • --profile <name> - Clear specific profile
  • --all - Clear all stored credentials

View application logs and events.

Terminal window
mailiam logs [type] [options]

Examples:

Terminal window
# View all recent logs
mailiam logs --last 1h
# View form submission logs
mailiam logs forms --last 24h
# View specific form logs
mailiam logs forms contact --last 6h
# Follow logs in real-time
mailiam logs --follow
# Filter by level
mailiam logs --level error --last 1d

Options:

  • --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)

View performance and usage metrics.

Terminal window
mailiam metrics [type] [options]

Examples:

Terminal window
# Overall metrics
mailiam metrics --last 7d
# Form submission metrics
mailiam metrics forms --last 30d
# Response time metrics
mailiam metrics performance --last 24h
# Error rate metrics
mailiam metrics errors --last 1d

Run comprehensive health checks.

Terminal window
mailiam health-check [options]

Examples:

Terminal window
# Run all health checks
mailiam health-check
# Check specific components
mailiam health-check --component forms
# Verbose output
mailiam health-check --verbose

Upgrade your mailiam subscription to Pro or Agency.

Terminal window
mailiam upgrade [options]

Examples:

Terminal window
# Interactive upgrade
mailiam upgrade
# Upgrade to Pro plan
mailiam upgrade --plan pro
# Upgrade to Agency plan
mailiam upgrade --plan agency

Options:

  • --plan <plan> - Target plan (pro, agency)

Check your current email usage and quota status.

Terminal window
mailiam usage [options]

Examples:

Terminal window
# View current usage
mailiam usage
# Show detailed usage breakdown
mailiam usage --detailed
# JSON output for scripting
mailiam usage --output json

Options:

  • --detailed - Show detailed usage breakdown by form/domain
  • --output <format> - Output format (table, json)

Manage billing and subscription.

Terminal window
mailiam billing <command> [options]

Examples:

Terminal window
# View billing status
mailiam billing status
# Open customer portal
mailiam billing portal
# View billing history
mailiam billing history

Manage reply identity preservation (SRS). This feature allows recipients to reply to forwarded emails while maintaining your domain’s identity.

Terminal window
mailiam reply <command> [options]

Examples:

Terminal window
# Check reply identity status
mailiam reply status
# Enable reply identity for a domain
mailiam reply enable example.com
# Configure authorized senders
mailiam reply authorize example.com sender@gmail.com

Quick setup for reply identity with authorized sender.

Terminal window
mailiam reply-quick-setup <domain> <email>

Examples:

Terminal window
# Quick setup reply identity
mailiam reply-quick-setup mysite.com me@gmail.com

Manage email signatures for SRS replies.

Terminal window
mailiam signatures <command> [options]

Examples:

Terminal window
# List configured signatures
mailiam signatures list
# Create a new signature
mailiam signatures create "professional" --template professional
# Show signature details
mailiam signatures show professional
# Delete a signature
mailiam signatures delete old-signature

Manage API keys for programmatic access.

Terminal window
mailiam apikeys <command> [options]

Examples:

Terminal window
# List all API keys
mailiam apikeys list
# Create a new public key
mailiam apikeys create --name "Website Forms" --type public --domain mysite.com
# Create a usage key
mailiam apikeys create --name "Backend API" --type usage
# Revoke an API key
mailiam apikeys revoke mlm_pk_abc123...

Key Types:

  • public (mlm_pk_*) - Client-safe, domain-scoped, 100 req/hour
  • usage (mlm_sk_*) - Server-side, 1000 req/hour
  • admin (mlm_sk_admin_*) - Full access, 10000 req/hour
  • agent (mlm_agent_*) - AI/MCP integrations, 5000 req/hour

Show version information.

Terminal window
mailiam version [options]

Options:

  • --verbose - Show detailed version information

Show help information.

Terminal window
# General help
mailiam help
# Command-specific help
mailiam help forms
# Show examples
mailiam help forms --examples

Generate shell completion scripts.

Terminal window
# Bash completion
mailiam completion bash >> ~/.bashrc
# Zsh completion
mailiam completion zsh >> ~/.zshrc
# Fish completion
mailiam completion fish >> ~/.config/fish/completions/mailiam.fish

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

The CLI uses standard exit codes:

  • 0 - Success
  • 1 - General error
  • 2 - Configuration error
  • 3 - Authentication error
  • 4 - Network error
  • 5 - Validation error
Terminal window
# 1. Initialize
mailiam init mysite.com
cd mysite.com
# 2. Configure domain
vim mailiam.config.yaml
# 3. Deploy
mailiam push
# 4. Verify
mailiam domains verify mysite.com
mailiam status
Terminal window
# 1. Create collection
mailiam collections create "support" "Support Forms"
# 2. Add forms
mailiam collections add-form "support" "technical" "Technical Support"
mailiam collections add-form "support" "billing" "Billing Questions"
# 3. Deploy
mailiam push
# 4. Test
mailiam forms test support/technical --data '{"email":"test@test.com","message":"test"}'
Terminal window
# 1. List existing forms
mailiam forms list
# 2. Create collection
mailiam collections create "company" "Company Forms"
# 3. Import form
mailiam collections import "company" "abc123def" "contact"
# 4. Deploy
mailiam push
# 5. Update your HTML to use new endpoint:
# https://api.mailiam.dev/f/company/contact

The mailiam CLI provides powerful, intuitive commands for every aspect of email infrastructure management.