Argorant Help
EN|DEargorant.comOpen Argorant
Help/AI agents & API

The Argorant CLI

Published by Argorant

npx argorant: count, search, reveal, export and check emails from your terminal. Setup, every command family, costs, exit codes and common mistakes.

The Argorant CLI is a small command line tool for your terminal. It does what the app does (count a market, preview people, reveal contacts, build checked CSV files, check your own addresses, manage lists, exports and webhooks) and it works the same for you at a keyboard, in a script, in CI and inside a coding agent like Claude Code or Codex.

What you need

  • Node.js 16 or newer, which comes with npx. Check with node --version.
  • An Argorant API key that starts with ag_live_. Create one under Settings, then API keys.

There is nothing to install. npx downloads the package the first time and runs the latest version:

npx argorant help

If you use it every day, install it once with npm install -g argorant and type argorant instead of npx argorant.

Sign in once

Settings, API keys, with a key name typed in and the Create key button
Create a key for the CLI under Settings, then API keys. A name like cli-laptop tells you later where it is used.
  1. Create a key in Settings and click Copy.
  2. Run npx argorant login and paste the key when it asks. The key is not shown while you paste.
  3. The CLI checks the key and prints Logged in as with your email. The key is saved in ~/.argorant/config.json, readable only by your user.
  4. Run npx argorant whoami to see your account, the key's permissions and today's limits.

For scripts and CI, skip the login and set the key in the environment. It always wins over a saved key:

export ARGORANT_API_KEY=ag_live_xxxxxxxxxxxxxxxxxxxxxxxx
A terminal: argorant whoami without a key prints no API key and exits 2, and argorant login with a wrong key prints that key was rejected (401)
Real output when no key is set and when a key is wrong. Both exit with code 2.

Your first commands

Start free. Counting and previewing never use credits:

npx argorant count "fintech CFOs in germany"
npx argorant count --title CFO --country Germany --employees-min 50
npx argorant search --title "head of procurement" --country Germany -n 10
npx argorant company stripe.com

When the size and the preview look right, spend credits on purpose:

npx argorant reveal --title CFO --country Germany -n 25
npx argorant export --title CFO --country Germany -n 500 -o cfos.csv

export creates the file on our side, waits until it is ready and saves it to the path you gave. If your connection drops, nothing is lost. Get the file again with npx argorant export download <job_id> -o cfos.csv, which is free.

The command families

CommandsWhat they doCost
login, logout, whoami, accountSave or forget the key, show the account, plan, credits and limitsFree
count, search, companySize a market, preview people with details hidden, look at one companyFree
companies count | search | peopleCompanies that match your filtersFree
lookup industries | countries | keywords | technologies | titlesThe exact labels to use in filtersFree
revealFull contact details (name, work email, LinkedIn)1 credit per new working email
export, export status, export downloadA checked CSV file, and getting it again later1 credit per working email, re-downloads free
lists, list create, list statusSaved lists: create, show, rename, delete, exportFree, exporting costs credits
verifyCheck addresses you already have, one or a whole fileHalf a credit per address
findA person's work email from a name and a company domain1 credit found, 0.25 credit not found
webhooksEvents sent to your own serverFree, Pro plan and up
campaigns, inbox, inboxesEmail campaigns, replies and mailboxesCampaigns need a plan

Phone numbers are never included unless you add --phones to reveal, enrich or export. A number costs 10 credits, only when one is returned, and phone numbers come with the Pro plan and up.

Filters

Every command that takes filters uses the same flags, with the same meaning as in the app: --title, --country, --industry, --keywords, --seniority, --department, --domain, --employees, --revenue, --city, --state and more. Each has an exclude twin, like --exclude-title. A comma means any of them. Run npx argorant filters for every filter and its values.

Options you will use

OptionWhat it does
-n, --limitThe most rows. Always set it before a command that spends.
-o, --outputWhere the CSV file goes.
--jsonRaw JSON output for scripts. It also skips the confirmation question.
-y, --yesSkip the confirmation question.
--phonesAdd phone numbers (10 credits per number found).
--idempotency-keyYour own key for a write, so running the command again replays the first answer.

Exit codes

CodeMeaning
0Success
1Error: wrong usage, network problem, a job that failed, or nothing found by find or enrich
2Not signed in, or the key was rejected
3The key lacks the permission for this action
4Rate limit or daily limit reached
5Out of credits or the plan does not include this; the message has the link to fix it

Common mistakes

  • No prompt in a script. reveal, export, lists export, verify --file and find only ask for confirmation at a real terminal without --yes or --json. In a pipe, in CI or in an agent they spend at once. Set -n first.
  • Logged out, still signed in. logout removes the saved key, but ARGORANT_API_KEY in your environment still works. Unset it too.
  • A typo in a number. -n 5OO stops with an error instead of using the default. That is on purpose.
  • Exit code 5 in a pipeline. The account needs credits or a plan. It is not a bug, so do not retry in a loop.

Limits

The CLI uses the same limits as the REST API, per key. Search, counts and masked previews do not deduct credits. Account permissions and rate limits still apply.

What happens next

Everything the CLI creates appears in the app: lists under Lists, files under Exports, spend in your balance. For the safety model and scripting with agents, read The CLI: install, shape and safety model. The full reference with every flag is at docs.argorant.com/docs/guides/cli.

Related
The CLI: install, shape and safety modelCLI exit codes and what to do with eachAPI keys and the REST APISpending guardrails: instructions that keep an agent cheap

Still stuck? support@argorant.com

Help homeargorant.comPricingRoadmap
support@argorant.com