ArgorantDocs

Linha de comando

Tudo pelo terminal com npx argorant. Saída em JSON para scripts e agentes, páginas com cursor, novas tentativas seguras e códigos de saída com que você pode agir.

Shell
npx argorant login           # paste a key from app.argorant.com/profile once
npx argorant account         # plan, credits, request limit, campaign emails

O npx executa a ferramenta sem instalar. Para instalá-la de vez, rode npm install -g argorant. A ferramenta lê a chave do argorant login ou da variável ARGORANT_API_KEY.

Comandos

ComandoO que faz
accountPlano, créditos, limite de requisições e e-mails de campanha
count "<words>" [filters]Conta as pessoas que correspondem, grátis
search "<words>" -n 10Uma prévia mascarada, grátis
company <domain>Quantas pessoas há em uma empresa, grátis
companies count / search / peopleEmpresas que correspondem aos seus filtros, grátis
lookup industries / countries / keywords / technologies / titles [text]Os nomes exatos para usar nos filtros, grátis
filtersTodos os filtros de busca com suas flags e valores, e quais já estão prontos, grátis
reveal "<words>" -n 25Dados completos com e-mails verificados, usa créditos
enrich --email a@b.com / --name "..." --domain d / --domain dCompleta um registro
find "Jane Doe" --domain acme.com / find --file people.csv -o found.csv --max-credits 100Encontra e-mails corporativos: 1 crédito quando encontrado, 0,25 quando nada é encontrado
find status / download / resume / cancel <job_id>, find pricingListas e preços do localizador de e-mails
lists ls / create / show / people / rename / rm / exportListas salvas
lists remove-people <id> --title Intern --preview / --ids a,bTira pessoas de uma lista salva. Primeiro conta e pergunta; --preview só conta. Adicionar a mesma busca de novo as deixa de fora
export "<words>" -n 1000 -o leads.csvUm CSV de contatos verificados, usa créditos
exports ls / status / downloadSuas exportações
verify <email> / verify --file emails.csv -o checked.csvVerifica e-mails que você já tem
campaigns list / create / update / status / deleteCampanhas e suas configurações
campaigns update <c> --no-skip-shared-bounces / --skip-shared-bouncesMantém os endereços que deram bounce para outros usuários do Argorant, ou os deixa de fora (o padrão)
campaigns emails set <c> --step 1 --subject ... --body-file fOs e-mails
campaigns leads add <c> --list <id> / leads list / leads removeAs pessoas de uma campanha
campaigns leads add <c> --list <id> --grades validA resposta quando uma adição pergunta quais endereços adicionar. valid (recomendado) adiciona só endereços válidos, valid,catch_all também os catch-all
campaigns leads remove <c> --not-replied --status queued --preview / leads jobs <c>Tira muitas pessoas de uma vez, com prévia primeiro; acompanha adições e remoções grandes
campaigns leads tag <c> <tag> --file ids.csv / leads remove <c> --tag <tag>Marca pessoas com uma tag e depois as tira, traz de volta, move ou lista pela tag
campaigns leads restore <c> --tag <tag> / --all-removedTraz de volta pessoas retiradas que nunca receberam e-mail, com prévia primeiro
campaigns leads move <c> --to <c2> --tag <tag>Move pessoas para outra campanha com os próprios campos, com prévia primeiro
campaigns personalize import <c> lines.csvLinhas personalizadas para muitas pessoas a partir de um arquivo
campaigns test <c> --step 1Um e-mail de teste para você, sem adicionar ninguém
campaigns folders / folders create --name / move <c> --folder <f>Pastas para campanhas
campaigns list --folder <f> / --no-folderAs campanhas de uma pasta, ou as que não estão em nenhuma pasta
campaigns senders set <c> --all / senders list / senders removeAs caixas de e-mail que enviam
campaigns launch / pause / stop <c>Inicia ou para o envio; o início pergunta antes, -y pula a pergunta
campaigns analytics <c> --days 30 / campaigns replies <c>Resultados e respostas de uma campanha
inbox list / read / reply / forward / classifyTodas as respostas em um só lugar
inbox stages / stages add / set / rmAs etapas do seu funil para respostas
inboxes list --status needs_attention --tag t / set / disconnect / connect-googleSuas caixas de e-mail
inboxes update --domains a.com --daily-limit 30Altera muitas caixas de e-mail de uma vez, com prévia primeiro
inboxes set <mailbox> --name "Elena Vaughn"O nome de remetente que as pessoas veem, uma caixa de e-mail por vez
inboxes tags / inboxes tag --order <id> --add "Q4 push" / inboxes order-tags <id> --add "Q4 push"Tags de caixas de e-mail com suas contagens, tags para muitas caixas de uma vez (com prévia primeiro) e as tags de um pedido, que também chegam às caixas que ele configurar depois (guia)
inboxes test-smtp / connect-smtp / connect-smtp --csv / presetsCaixas de e-mail de qualquer provedor (guia); a senha é pedida ou lida de uma variável de ambiente, nunca da linha de comando
inboxes quote / order / status / renewalNovas caixas de e-mail em novos domínios
blocklist list / add / remove / jobEndereços e domínios que nunca são contatados. list mostra 50 por vez (--all, --search, --campaign); add e remove aceitam muitos valores ou --file list.csv (chamadas de 5.000), --campaign para campanhas específicas e --dry-run
webhooks ls / add / set / test / deliveries / rmEventos enviados ao seu servidor, a partir do plano Pro

Filtros

Todo comando de busca (count, search, reveal, export, lists create, adicionar a uma lista, companies) aceita os mesmos filtros do app, da API e do conector do Claude. Uma vírgula significa qualquer um deles. Cada filtro de lista tem um par de exclusão que remove todos que o filtro de inclusão encontraria para os mesmos valores, e os dois podem ser usados juntos.

IncluirExcluirO que corresponde
--title--exclude-titleCargos; formas curtas funcionam nos dois sentidos (CFO, Chief Financial Officer)
--keywords--exclude-keywordsPalavras que descrevem o que a empresa faz, como fintech (--keyword-scope people para as habilidades das próprias pessoas)
--industry--exclude-industrySetores em palavras simples
--country--exclude-countryPaíses ou regiões como DACH, Nordics, APAC
--state--exclude-stateEstados ou províncias, por nome ou sigla
--city--exclude-cityCidades
--seniority--exclude-seniorityC-Level, VP, Director, Manager, Senior, Entry, Intern
--department--exclude-departmentSales, Marketing, Engineering, Finance e os outros departamentos
--domain--exclude-domainSites de empresas, como stripe.com

Como as palavras correspondem:

  • --title-match words (padrão) exige cada palavra como palavra inteira, então Data não corresponde a Database. exact exige o cargo inteiro, então CEO não corresponde a Founder & CEO. contains encontra o texto em qualquer lugar, também dentro de uma palavra.
  • Por padrão, as palavras-chave olham para o que a empresa faz (nome, tags, setor e descrição). --keyword-scope people olha para as habilidades e os perfis das próprias pessoas, e any para os dois, mais os cargos.
  • --industry-match primary corresponde só ao setor principal da empresa, então Software deixa de fora um varejista ou um banco que também tem uma tag de software. any (o padrão) corresponde a qualquer um dos seus setores.
  • --country-match person (o padrão) considera onde a pessoa está e deixa de fora pessoas cuja localização não é conhecida. person_or_company usa o país da empresa para elas.

Há mais filtros também, como --employees 51-200, --employees-min e --employees-max, --revenue 10m-50m, --revenue-min e --revenue-max, --company (várias empresas: junte os nomes com |), --has-phone e --has-linkedin. npx argorant filters lista todos os filtros que você pode usar.

Shell
npx argorant count --title "VP Sales" --title-match exact --country DACH --exclude-country Switzerland
npx argorant export --keywords fintech --exclude-keywords "venture capital, private equity" -n 500 -o fintech.csv

Uma lista salva é preenchida em segundo plano. lists show <id> diz se ela ainda está sendo preenchida; adicionar a uma lista que ainda está sendo preenchida espera a sua vez.

Feito para scripts e agentes

  • --json em qualquer comando imprime a resposta da API como ela é.
  • As listas imprimem um cursor abaixo de cada página. Passe-o com --cursor, ou adicione --all para ler todas as páginas.
  • Toda escrita recebe um Idempotency-Key novo. Passe --idempotency-key <key> para escolher o seu, assim rodar o mesmo comando de novo devolve a primeira resposta em vez de fazer o trabalho duas vezes.
  • Os códigos de saída são 0 para sucesso, 1 para um erro (e para find sem resultado), 2 para uma chave ausente ou errada, 3 para um escopo ausente, 4 para um limite de requisições ou diário, 5 quando é preciso um plano ou mais créditos, e 6 quando é preciso fazer uma escolha antes e nada foi alterado (campaigns leads add pergunta quais tipos de endereço adicionar).
  • Comandos que alteram muitas pessoas ou caixas de e-mail (leads remove, leads restore, leads move, lists remove-people, inboxes tag, inboxes update) primeiro contam e depois perguntam. --preview só conta, e --yes pula a pergunta.
  • Os erros imprimem o código, a mensagem em texto simples e o id da requisição.
  • Comandos que gastam créditos perguntam antes em um terminal. Eles não perguntam quando a saída não é um terminal, nem com --yes ou --json, então confira o seu -n nos scripts.
  • Uma campanha pode ser indicada pelo id ou pelo começo do nome.

De uma busca a uma campanha em andamento

Shell
npx argorant lists create --name "UK finance leaders" --title "CFO, Finance Director" --country "United Kingdom"
npx argorant campaigns create --name "UK finance Q4" --daily-limit 40 --timezone Europe/London
npx argorant campaigns emails set "UK finance" --step 1 --subject "Quick question, {{first_name}}" --body-file step1.txt
npx argorant campaigns leads add "UK finance" --list 1240
# when the list also holds catch-all or unchecked addresses, it asks first and adds nothing (exit code 6):
npx argorant campaigns leads add "UK finance" --list 1240 --grades valid
# business emails only: add --exclude-private-emails (free mail and home internet addresses are left out)
npx argorant campaigns senders set "UK finance" --all
npx argorant campaigns launch "UK finance"

Nesta página