@clera/instantly-cli

A modern CLI for managing Instantly.ai email campaigns, accounts, leads, and more.

Installation

npm install -g @clera/instantly-cli

Configuration

Set your Instantly API key as an environment variable:

export INSTANTLY_API_KEY=your_api_key_here

Or create a .env file in your working directory:

INSTANTLY_API_KEY=your_api_key_here

Commands

Campaigns

instantly-cli campaigns list              # List all campaigns
instantly-cli campaigns get <id>          # Get campaign details
instantly-cli campaigns analytics         # Campaign analytics (all)
instantly-cli campaigns analytics -c <id> # Analytics for specific campaign
instantly-cli campaigns daily             # Daily analytics breakdown
instantly-cli campaigns pause <id>        # Pause a campaign
instantly-cli campaigns activate <id>     # Activate a campaign
instantly-cli campaigns delete <id>       # Delete a campaign

Accounts

instantly-cli accounts list               # List email accounts
instantly-cli accounts get <email>        # Get account details
instantly-cli accounts warmup -e <email>  # Warmup analytics

Leads

instantly-cli leads list                  # List all leads
instantly-cli leads search <query>        # Search by name or email
instantly-cli leads get <id>              # Get lead details
instantly-cli leads delete <id>           # Delete a lead

Emails

instantly-cli emails list                 # List emails
instantly-cli emails list --type received # Filter by type
instantly-cli emails list --unread        # Unread only
instantly-cli emails get <id>             # Get email details
instantly-cli emails unread               # Count unread emails
instantly-cli emails thread <id>          # View thread

Lead Lists

instantly-cli lists list                  # List all lead lists
instantly-cli lists create <name>         # Create a new list
instantly-cli lists delete <id>           # Delete a list

Lead Labels

instantly-cli labels list                 # List all labels
instantly-cli labels get <id>             # Get label details
instantly-cli labels create <name>        # Create a label
instantly-cli labels update <id>          # Update a label
instantly-cli labels delete <id>          # Delete a label

Custom Tags

instantly-cli tags list                   # List all tags
instantly-cli tags get <id>               # Get tag details
instantly-cli tags create <name>          # Create a tag
instantly-cli tags update <id>            # Update a tag
instantly-cli tags delete <id>            # Delete a tag
instantly-cli tags assign --tag <id> --resource <id>  # Assign tag

Blocklist

instantly-cli blocklist list              # List blocked emails/domains
instantly-cli blocklist add <value>       # Block an email or domain
instantly-cli blocklist bulk-add <values> # Block multiple entries
instantly-cli blocklist delete <id>       # Remove from blocklist
instantly-cli blocklist export            # Export as CSV

Email Verification

instantly-cli verify check <email>        # Check verification status
instantly-cli verify submit <email>       # Submit for verification

Webhooks

instantly-cli webhooks list               # List all webhooks
instantly-cli webhooks get <id>           # Get webhook details
instantly-cli webhooks create -u <url> -e <event>  # Create webhook
instantly-cli webhooks delete <id>        # Delete a webhook
instantly-cli webhooks test <id>          # Send test event
instantly-cli webhooks resume <id>        # Resume errored webhook
instantly-cli webhooks events             # List event types

Background Jobs

instantly-cli jobs list                   # List background jobs
instantly-cli jobs get <id>               # Get job details

Global Options

All list commands support:

• --json — Output raw JSON
• --force — Skip confirmation on destructive actions

License

MIT