Instantly AI CLI

A command-line interface for the Instantly.ai API V2. The project currently implements the full in-scope Instantly API v2 surface for campaigns, leads, accounts, analytics, deliverability, webhooks, and related workspace resources from the terminal.

Installation

go build -o instantly .

Configuration

The CLI resolves configuration in this priority order:

1. CLI flags
2. Environment variables (INSTANTLY_API_KEY, INSTANTLY_OUTPUT_FORMAT)
3. Config file (~/.config/instantly/config.yaml)

Save your API key:

./instantly auth <your-api-key>

Or pass it directly:

./instantly --api-key <key> account list

Usage

Commands follow the pattern: instantly <resource> <action> [flags]

# Authenticate once, then use the saved key
instantly auth <your-api-key># Accounts
instantly account list
instantly account get --email user@example.com
instantly account test-vitals --emails user@example.com
# Campaigns
instantly campaign list --limit 50
instantly campaign get --id <uuid>
instantly campaign activate --id <uuid>
instantly campaign pause --id <uuid># Leads
instantly lead list --campaign <uuid>
instantly lead create --email lead@example.com --campaign <uuid># Inspect exact flags for complex commands
instantly account create --help
instantly campaign create --help
instantly webhook create --help

Utility Commands

These commands ship with the CLI but are not API resource groups:

• auth - Save an API key to ~/.config/instantly/config.yaml
• skill - Install the bundled SKILL.md for agent tools
• completion - Generate shell completion scripts

Agent Skill Installation

The CLI includes a bundled AI-agent skill for tools that support SKILL.md-based workflows. This skill is meant for agents using the installed instantly binary to operate the Instantly API correctly.

instantly skill install
instantly skill install --target agents --target claude
instantly skill install --target codex --force

By default, the installer writes SKILL.md into:

• ~/.agents/skills/instantly-cli/
• ~/.claude/skills/instantly-cli/
• ~/.codex/skills/instantly-cli/

Global Flags

Flag	Short	Description
--api-key	-k	API key (also via INSTANTLY_API_KEY env var)
--output	-o	Output format: json, table, csv
--no-color		Disable colored output
--verbose	-v	Show request/response details

Pagination Flags

Most list commands support:

• --limit - Number of items per page
• --starting-after - Cursor for the next page
• --all - Auto-paginate and return all results

Supported Resources

Resource	CLI Subcommand
Account	account
Analytics	analytics
Account Campaign Mapping	account-campaign-mapping
Audit Log	audit-log
Background Job	background-job
Block List Entry	block-list-entry
Campaign	campaign
Campaign Subsequence	subsequence
CRM Actions	crm
Custom Prompt Template	prompt-template
Custom Tag	custom-tag
Custom Tag Mapping	custom-tag-mapping
Email	email
Email Template	email-template
Email Verification	email-verification
Inbox Placement Analytics	inbox-placement-analytics
Inbox Placement Reports	inbox-placement-report
Inbox Placement Test	inbox-placement-test
Lead	lead
Lead Label	lead-label
Lead List	lead-list
Sales Flow	sales-flow
SuperSearch Enrichment	supersearch
Webhook	webhook
Webhook Event	webhook-event
Workspace	workspace
Workspace Group Member	workspace-group-member
Workspace Member	workspace-member

Intentionally Excluded API Groups

These Instantly API v2 groups are currently out of scope for this CLI:

• oauth
• api-key
• workspace-billing
• dfy-order

Development

# Build
go build -o instantly .# Run tests
go test ./...
# Run tests (verbose)
go test -v ./...

Tech Stack

• Go 1.24+
• Cobra for CLI commands
• Viper for configuration
• Standard library net/http for API calls

API Reference

• Base URL:https://api.instantly.ai/
• Auth: Bearer token via Authorization: Bearer <api_key> header
• Rate Limits: 100 requests per second; 6,000 requests per minute (workspace-wide, shared across API keys)
• Docs:https://developer.instantly.ai/

License

MIT