Quickstart

Install the CLI, authenticate with an API v2 key, and list campaigns in your workspace.

Prerequisites

Install the CLI

Install the package globally with npm:

npm install -g @instantlyai/cli

To run a command without installing the package globally, use npx:

npx @instantlyai/cli campaigns list

Authenticate

Run the interactive login command:

instantly login

Enter your API key when prompted. The CLI validates the key and stores it in ~/.instantly/config.json.

Keep your API key secure. Never share the CLI configuration file or commit it to source control.

Run your first command

List the campaigns in your workspace:

instantly campaigns list --pretty

The CLI returns JSON. The --pretty flag formats it for terminal output.

Set INSTANTLY_API_KEY when you need non-interactive authentication:

export INSTANTLY_API_KEY="your-api-key"
instantly campaigns list

The CLI resolves credentials in this order:

Every command returns JSON by default. Use output flags to control what the CLI prints:

instantly campaigns list --pretty
instantly campaigns list --fields "id,name,status"
instantly campaigns list --quiet

instantly accounts list
instantly analytics campaign-overview
instantly email unread-count

The CLI also includes a local MCP server. Run instantly mcp, or use the hosted Instantly MCP server without installing the CLI.