Choose the installation method that works best for your environment.
| Homebrew | Prebuilt Binary | From Source |
|---|---|---|
|
Recommended for macOS or Linux. Homebrew handles installation and upgrades. [View Homebrew instructions](#homebrew). |
Download a standalone binary for macOS, Linux, or Windows. Node.js isn't required. [View binary instructions](#prebuilt-binary). |
Build Apollo CLI locally with Node.js 18 or above. [View source instructions](#from-source). |
Homebrew
To install via Homebrew: ```bash brew install apolloio/apollo-io-cli/apollo-io-cli ``` Or tap once, then install by short name: ```bash brew tap apolloio/apollo-io-cli brew trust apolloio/apollo-io-cli brew install apollo-io-cli ``` Upgrade anytime with `brew upgrade apollo-io-cli`.Prebuilt binary
No Node.js required. Download the binary for your platform from the [GitHub releases page](https://github.com/apolloio/apollo-io-cli/releases): | Platform | File | | --------------------- | ------------------------ | | macOS (Apple Silicon) | `apollo-macos-arm64` | | macOS (Intel) | `apollo-macos-x64` | | Linux (x64) | `apollo-linux-x64` | | Windows (x64) | `apollo-windows-x64.exe` | To set up the binary on macOS or Linux: 1. Make the file executable and move it to your PATH. ```bash chmod +x apollo-macos-arm64 mv apollo-macos-arm64 /usr/local/bin/apollo xattr -d com.apple.quarantine /usr/local/bin/apollo ``` To set up the binary on Windows, rename it to `apollo.exe` and place it in a directory on your `PATH` (for example, `%USERPROFILE%\bin`): ```powershell Move-Item .\apollo-windows-x64.exe "$env:USERPROFILE\bin\apollo.exe" ``` You have now installed Apollo CLI. Each release also includes a GPG signature file. To verify the binary: ```bash gpg --import release-signing-key.asc gpg --verify apollo-macos-arm64.asc apollo-macos-arm64 ```From source
Requires Node 18 or above. ```bash git clone https://github.com/apolloio/apollo-io-cli.git cd apollo-io-cli npm install npm link ```Authenticate
Apollo CLI uses OAuth 2.0 — no API key needed. Log in once and your token refreshes automatically. To authenticate: 1. Run the login command. Your browser opens to authorize the connection and saves your credentials to `~/.config/apollo/credentials`. ```bash apollo auth login ``` 2. Confirm you're logged in. ```bash apollo auth whoami ``` You have now authenticated Apollo CLI. To log out and revoke your credentials at any time, run `apollo auth logout`. > **Check Yourself Before You Wreck Yourself** > Run `apollo auth whoami` before any other command. If authentication fails, resolve it first — don't work around it. *** ## Use Apollo CLI with AI Agents Apollo CLI works natively with AI coding agents. A [Claude Code skill](https://github.com/apolloio/apollo-io-cli/blob/main/.claude/skills/apollo-cli/SKILL.md) is available that gives the agent full knowledge of every command, its options, JSON response shapes, and `jq` examples. The skill gives AI agents detailed knowledge of Apollo CLI commands, options, response shapes, and `jq` examples. Install it globally to make it available across projects or locally to scope it to a single repository. * [Set up with Claude Code](#set-up-with-claude-code) * [Set up with Cursor or other agents](#set-up-with-cursor-or-other-agents)Set up with Claude Code
**Global install** (available in every project on your machine): ```bash mkdir -p ~/.claude/skills/apollo-cli curl -fsSL https://raw.githubusercontent.com/apolloio/apollo-io-cli/main/.claude/skills/apollo-cli/SKILL.md \ -o ~/.claude/skills/apollo-cli/SKILL.md ``` **Per-project install** (scoped to one repo): ```bash mkdir -p .claude/skills/apollo-cli curl -fsSL https://raw.githubusercontent.com/apolloio/apollo-io-cli/main/.claude/skills/apollo-cli/SKILL.md \ -o .claude/skills/apollo-cli/SKILL.md ``` **Windows (PowerShell)** — global install: ```powershell New-Item -ItemType Directory -Force "$env:USERPROFILE\.claude\skills\apollo-cli" | Out-Null Invoke-WebRequest ` -Uri https://raw.githubusercontent.com/apolloio/apollo-io-cli/main/.claude/skills/apollo-cli/SKILL.md ` -OutFile "$env:USERPROFILE\.claude\skills\apollo-cli\SKILL.md" ``` For a per-project install on Windows, swap `$env:USERPROFILE\.claude` for `.claude` in the path above. Claude Code automatically loads any skill file it finds — global or local. You can also invoke it manually with `/apollo-cli`.Set up with Cursor or other agents
Point your project instructions at the raw skill URL directly — no file copying required: ``` https://raw.githubusercontent.com/apolloio/apollo-io-cli/main/.claude/skills/apollo-cli/SKILL.md ``` Add this URL to your `AGENTS.md` or project instructions and any agent in any repo can use it. It always reflects the latest version. *** ## Available commands Browse Apollo CLI commands by what you want to accomplish: * **Research and prospect** * [People](#people) * [Companies](#companies) * [News](#news) * **Manage records** * [Contacts](#contacts) * [Accounts](#accounts) * [Deals](#deals) * [Labels](#labels) * [Fields](#fields) * [Notes](#notes) * **Engage prospects** * [Email accounts](#email-accounts) * [Sequences](#sequences) * [Emails](#emails) * [Calls](#calls) * [Tasks](#tasks) * **Analyze activity and performance** * [Conversations](#conversations) * [Analytics](#analytics) * **Manage access and operations** * [Users](#users) * [Usage and credits](#usage-and-credits) * [Auth](#auth) * [Webhooks](#webhooks)People
Search for people, enrich profiles, retrieve contact details, and find employees at specific companies. ```bash apollo people search \ --title "VP Engineering" \ --city "San Francisco" \ --seniority vp \ --domain stripe.com \ --per-page 25 apollo people enrich --email jordan@northstar.io apollo people enrich --name "Jordan Lee" --company "Northstar" apollo people enrich --linkedin https://linkedin.com/in/jordanlee apollo people enrich \ --first-name Jordan \ --last-name Lee \ --company "Northstar" apollo people search \ --title CTO \ --employees "51,200" \ --hiring-for "Software Engineer" apollo people bulk-enrich --emails jordan@northstar.io maya@cedarpeaklabs.com apollo people email --idCompanies
Search for companies, enrich company profiles, retrieve organization details, and find active job postings. ```bash apollo companies search \ --industry SaaS \ --employees "51,200" \ --location "United States" \ --per-page 25 apollo companies search \ --technology react \ --not-location China \ --funding "1000000,10000000" apollo companies search \ --name "Cedar Peak Labs" \ --domains cedarpeaklabs.com \ --per-page 10 apollo companies search \ --hiring-for "Account Executive" \ --job-locations "New York" \ --num-jobs "5,50" apollo companies enrich --domain stripe.com apollo companies enrich --name "Stripe" apollo companies bulk-enrich --domains stripe.com notion.so apollo companies get --idNews
Find news articles associated with a company using its name or Apollo organization ID. ```bash apollo news search --company "Stripe" apollo news search --idContacts
Manage CRM contacts in your team's Apollo account. ```bash apollo contacts search --query "revenue operations" --per-page 25 apollo contacts create --first-name Priya --last-name Shah --email priya@northstaranalytics.io apollo contacts update --idAccounts
Manage CRM accounts that your team has added to Apollo. ```bash apollo accounts create --name "Cedar Peak Labs" --domain cedarpeaklabs.com apollo accounts update --idDeals
Create, search, view, and update opportunities in your Apollo CRM. ```bash apollo deals create \ --name "Horizon Grid - Annual Renewal" \ --amount 50000 \ --currency USD \ --account-idEmail accounts
List the sending mailboxes connected to your team's Apollo account. ```bash apollo email-accounts list ``` Use the returned mailbox ID as the value for `--from-email-account` when you run `apollo sequences add-contacts`.Sequences
Create and update sequences, manage sending schedules, approve sequence changes, and enroll or remove contacts. ```bash apollo sequences search --query "fintech outreach" --per-page 10 apollo sequences schedules apollo sequences create \ --name "Q3 Fintech Outreach" \ --steps-file ./steps.json \ --schedule-idCalls
Log phone calls, search existing call records, and update call details. ```bash apollo calls log \ --contact-idTasks
Create, search, view, update, complete, and skip Apollo tasks. Each task must be associated with a contact, account, or opportunity. ```bash apollo tasks create \ --user-idUsers
View your Apollo profile and find other users in your team's Apollo account. ```bash apollo users profile apollo users profile --credits apollo users search --query "engineer" ``` | Command | What It Does | Common Options | | ---------------------- | ------------------------------------------------ | --------------------------------------------------- | | `apollo users profile` | View your authenticated Apollo user profile. | Optional `--credits` to include credit usage fields | | `apollo users search` | Find teammates by name, email address, or title. | `--query`, `--page`, `--per-page` |Emails
Draft, send, check, and search one-off outreach emails outside sequences. ```bash apollo emails draft \ --contact-idHi Mateo,
Would you be open to a short conversation next week?
" apollo emails send --idLabels
Create and manage Apollo contact and account lists. ```bash apollo labels list apollo labels create --name "SaaStr 2026 Prospects" --modality contacts apollo labels update --idFields
List Apollo fields and create custom fields. ```bash apollo fields list apollo fields list --source custom apollo fields create --label "Renewal Date" --modality contact --type date apollo fields custom ``` | Command | What It Does | Common Options | | ---------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `apollo fields list` | List available fields. | Optional `--source` | | `apollo fields create` | Create a custom field. | `--label`, `--modality contact\|account\|opportunity`, `--type string\|textarea\|number\|date\|datetime\|boolean`, optional `--max-length` | | `apollo fields custom` | List custom typed fields and the field IDs used in `typed_custom_fields` payloads. | None |Notes
List notes associated with contacts, accounts, opportunities, calendar events, or conversations. ```bash apollo notes list --contact-idConversations
Search recorded calls and meetings, view conversation details, and export Conversation Intelligence data. ```bash apollo conversations search \ --type phone_call \ --date-from 2026-01-01T00:00:00Z \ --limit 25 apollo conversations show --idWebhooks
Retrieve the stored result of an asynchronous webhook-based request, such as an asynchronous bulk enrichment request. ```bash apollo webhooks result --request-idAuth
| Command | What It Does | | -------------------- | ---------------------------------------------------------------------------------- | | `apollo auth login` | Authorize Apollo CLI through browser-based OAuth and save the credentials locally. | | `apollo auth whoami` | Confirm which Apollo user is currently authenticated. | | `apollo auth logout` | Revoke the current token and remove the saved credentials. |Usage and credits
Review your team's credit consumption and API rate-limit usage. ```bash apollo usage credits apollo usage api ``` | Command | What It Does | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `apollo usage credits` | View your team's limits, consumption, and remaining lead, direct-dial, export, conversation, AI, and power-up credits. | | `apollo usage api` | View per-endpoint API usage, rate limits, and remaining request capacity. | The `usage credits` response includes each available credit type with its limit, consumed amount, and remaining balance.Analytics
Run an Apollo analytics report using a complete `sync_report` request body from a JSON file. ```bash apollo analytics report --payload ./report.json ``` | Command | What It Does | Common Options | | ------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------- | | `apollo analytics report` | Send a complete analytics request body to Apollo's synchronous reporting endpoint. | Required: `--payload`. Optional: `--format` | Apollo CLI passes the JSON payload through without transforming it. The file must contain the complete metrics, grouping, filter, sorting, and date-range structure expected by the analytics endpoint. Example `report.json`: ```json { "metrics": [ { "value": "num_emails_sent", "smart_datetime_reference": "emailer_message__sent_at", "smart_user_id_reference": "emailer_message__user_id" } ], "group_by": [], "pivot_group_by": [], "sorts": [], "filters": {}, "date_ranges": [ { "modality": "last_30_days" } ], "group_by_totals_selected": false, "pivot_group_by_totals_selected": false } ``` ## Output and best practices Review [global flags](#global-flags), [output formats](#output-formats), [pagination](#pagination), and [best practices](#best-practices) for reliable terminal, script, and AI-agent workflows.Global flags
Global flags must appear before the command group and subcommand. | Flag | Description | | -------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `--add-headerOutput formats
Every command accepts `-f, --format`. The default format is `json`. | Format | Flag | Best For | | ------ | ---------------- | -------------------------------------------------------------------------------------------- | | JSON | `--format json` | Pretty-printed structured output for scripts, AI agents, and `jq`. | | JSONL | `--format jsonl` | One JSON object per line for streaming and data pipelines. | | CSV | `--format csv` | Flat exports for spreadsheets. Nested objects and arrays are stringified into a single cell. | | YAML | `--format yaml` | Human-readable inspection of deeply nested responses. | | Table | `--format table` | Quick terminal browsing of small responses. | ```bash apollo companies search --industry SaaS --format table apollo people bulk-enrich \ --emails jordan@northstar.io maya@cedarpeaklabs.com \ --format jsonl apollo news search --company "Stripe" --format yaml apollo people search \ --title CTO \ --domain stripe.com \ --format csv > ctos.csv ``` Search and list responses typically contain pagination metadata alongside an array of records. CSV and table output may render that array as a stringified value. For analysis or record extraction, use JSON with `jq`: ```bash apollo companies search --industry SaaS --format json \ | jq '.accounts[]' --compact-output > companies.jsonl apollo people search --domain stripe.com --format json \ | jq '.people[] | {name: .name, title: .title}' ``` ***Pagination
Use these flags to page through large result sets: * `--per-pageBest Practices
* **Authenticate first** — Run `apollo auth whoami` before anything else. Surface errors to the user — don't work around them. * **Use JSON and `jq` together** — `--format json` is the most reliable format for field extraction in scripts and agents. * **Don't guess IDs** — Always call `apollo email-accounts list` to get a verified inbox ID before enrolling contacts in a sequence. * **Treat sequence enrollment as a write action** — `sequences add-contacts` sends real emails. Confirm the sequence, sender, and contact list first. * **Page through large result sets** — The default is ten results per page. Use `--per-page` and `--page` for larger searches. *** ## Next Steps Check out the following resources to keep building with Apollo: | Resource | Description | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | [Apollo API](https://docs.apollo.io/reference/apollo-api) | Get familiar with Apollo API, the same endpoints CLI uses under the hood. | | [Apollo MCP](https://docs.apollo.io/docs/apollo-mcp) | Use Apollo directly inside your favorite AI tool without leaving the conversation. | | [Search for People](https://knowledge.apollo.io/hc/en-us/articles/4412658716941) | Learn how people search works and what filters are available. | | [Enrichment Overview](https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview) | Understand how enrichment works, what data it returns, and how credits are consumed. | | [Developer FAQs](https://docs.apollo.io/docs/apollo-api-faqs) | Find answers to the most common questions about Apollo API. |