ArgorantDocs

コマンドライン

npx argorantで、すべてをターミナルから操作できます。スクリプトやエージェント向けのJSON出力、カーソルによるページ送り、安全な再試行、判断に使える終了コードを備えています。

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

npxを使えばインストールせずに実行できます。常に使えるようにインストールするには、npm install -g argorantを実行します。ツールはargorant loginまたはARGORANT_API_KEY変数からキーを読み取ります。

コマンド

コマンド内容
accountプラン、クレジット、リクエストの上限、キャンペーンメール
count "<words>" [filters]条件に一致する人物の件数を確認します。無料
search "<words>" -n 10一部を伏せたプレビュー。無料
company <domain>1社に何人いるか。無料
companies count / search / peopleフィルターに一致する企業。無料
lookup industries / countries / keywords / technologies / titles [text]フィルターに使う正確な名称。無料
filtersすべての検索フィルターと、そのフラグ、値、現在使えるかどうか。無料
reveal "<words>" -n 25チェック済みのメールを含む詳細情報。クレジットを使います
enrich --email a@b.com / --name "..." --domain d / --domain d1件のレコードを補完します
find "Jane Doe" --domain acme.com / find --file people.csv -o found.csv --max-credits 100業務用メールを見つけます。見つかった場合は1クレジット、見つからなかった場合は0.25クレジットです
find status / download / resume / cancel <job_id>, find pricingメールアドレス検索のリストと料金
lists ls / create / show / people / rename / rm / export保存済みのリスト
lists remove-people <id> --title Intern --preview / --ids a,b保存済みのリストから人物を外します。先に件数を数えてから確認します。--previewは件数を数えるだけです。同じ検索を再び追加しても、外した人物は含まれません
export "<words>" -n 1000 -o leads.csvチェック済みのコンタクトのCSV。クレジットを使います
exports ls / status / downloadあなたのエクスポート
verify <email> / verify --file emails.csv -o checked.csv手元にあるメールをチェックします
campaigns list / create / update / status / deleteキャンペーンとその設定
campaigns update <c> --no-skip-shared-bounces / --skip-shared-bounces他のArgorantユーザーでバウンスしたアドレスを残すか、除外するか(既定は除外)
campaigns emails set <c> --step 1 --subject ... --body-file fメール本文
campaigns leads add <c> --list <id> / leads list / leads removeキャンペーン内の人物
campaigns leads add <c> --list <id> --grades valid追加時にどのアドレスを追加するか尋ねられたときの回答です。valid(推奨)は有効なアドレスだけを追加し、valid,catch_allはキャッチオールのアドレスも追加します
campaigns leads remove <c> --not-replied --status queued --preview / leads jobs <c>多くの人物をまとめて外します。先にプレビューし、大規模な追加や削除の進み具合を追えます
campaigns leads tag <c> <tag> --file ids.csv / leads remove <c> --tag <tag>人物にタグを付け、タグ単位で外す、戻す、移動する、一覧表示するといった操作をします
campaigns leads restore <c> --tag <tag> / --all-removed外した人物のうち、まだメールを送っていない人を戻します。先にプレビューします
campaigns leads move <c> --to <c2> --tag <tag>人物を独自の項目ごと別のキャンペーンに移動します。先にプレビューします
campaigns personalize import <c> lines.csv1つのファイルから、多くの人物の個別の一文を読み込みます
campaigns test <c> --step 1あなた宛てにテストメールを1通送ります。人物は追加されません
campaigns folders / folders create --name / move <c> --folder <f>キャンペーンのフォルダー
campaigns list --folder <f> / --no-folder1つのフォルダーのキャンペーン、またはどのフォルダーにも入っていないキャンペーン
campaigns senders set <c> --all / senders list / senders remove送信に使うメールボックス
campaigns launch / pause / stop <c>送信を開始または停止します。開始時は先に確認し、-yで確認を省略します
campaigns analytics <c> --days 30 / campaigns replies <c>1つのキャンペーンの結果と返信
inbox list / read / reply / forward / classifyすべての返信を1か所で
inbox stages / stages add / set / rm返信のパイプラインのステージ
inboxes list --status needs_attention --tag t / set / disconnect / connect-googleあなたのメールボックス
inboxes update --domains a.com --daily-limit 30多くのメールボックスをまとめて変更します。先にプレビューします
inboxes set <mailbox> --name "Elena Vaughn"相手に表示される送信者名。1つのメールボックスごとに設定します
inboxes tags / inboxes tag --order <id> --add "Q4 push" / inboxes order-tags <id> --add "Q4 push"メールボックスのタグとその件数、多くのメールボックスへのまとめてのタグ付け(先にプレビュー)、注文のタグ。注文のタグは、その注文があとから設定するメールボックスにも付きます(ガイド)
inboxes test-smtp / connect-smtp / connect-smtp --csv / presets任意のプロバイダーのメールボックス(ガイド)。パスワードは入力を求められるか環境変数から読み取られ、コマンドラインから受け取ることはありません
inboxes quote / order / status / renewal新しいドメイン上の新しいメールボックス
blocklist list / add / remove / job決して連絡しないアドレスとドメイン。listは一度に50件を表示します(--all、--search、--campaign)。addとremoveは複数の値または--file list.csv(5,000件ずつの呼び出し)、個別のキャンペーン向けの--campaign、--dry-runを受け付けます
webhooks ls / add / set / test / deliveries / rmサーバーに送られるイベント。Proプラン以上

フィルター

すべての検索コマンド(count、search、reveal、export、lists create、リストへの追加、companies)は、アプリ、API、Claudeコネクタと同じフィルターを受け付けます。カンマで区切ると、いずれかに一致するものが対象になります。リスト型の各フィルターには除外用の対があり、同じ値で含める側のフィルターが見つける人物をすべて除外します。両方を同時に使うこともできます。

含める除外する一致する対象
--title--exclude-title役職。略称と正式名称のどちらでも一致します(CFO、Chief Financial Officer)
--keywords--exclude-keywordsfintechなど、企業の事業内容を表す語句(人物自身のスキルを対象にするには--keyword-scope people)
--industry--exclude-industry一般的な言葉で表した業界
--country--exclude-country国、またはDACH、Nordics、APACなどの地域
--state--exclude-state州や県。名称またはコードで指定します
--city--exclude-city都市
--seniority--exclude-seniorityC-Level、VP、Director、Manager、Senior、Entry、Intern
--department--exclude-departmentSales、Marketing、Engineering、Financeなどの部門
--domain--exclude-domainstripe.comなどの企業のWebサイト

語句の一致の仕方は次のとおりです。

  • --title-match words(既定)は、すべての語が単語全体として含まれている必要があるため、DataはDatabaseに一致しません。exactは役職全体の一致が必要なため、CEOはFounder & CEOに一致しません。containsは、単語の中も含めてどこにあっても見つけます。
  • キーワードは、既定では企業の事業内容(企業名、タグ、業界、説明)を対象にします。--keyword-scope peopleは人物自身のスキルとプロフィールを、anyはその両方と役職を対象にします。
  • --industry-match primaryは企業の主要な業界だけに一致するため、Softwareを指定すると、softwareのタグも持つ小売業者や銀行は除外されます。any(既定)は、企業のいずれかの業界に一致します。
  • --country-match person(既定)は人物の拠点を基準にし、本人の所在地が不明な人物は除外します。person_or_companyは、そうした人物について企業の国を使います。

ほかにも、--employees 51-200、--employees-minと--employees-max、--revenue 10m-50m、--revenue-minと--revenue-max、--company(複数の企業を指定する場合は名前を|でつなぎます)、--has-phone、--has-linkedinなどのフィルターがあります。npx argorant filtersで、使えるすべてのフィルターを一覧表示できます。

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

保存済みのリストはバックグラウンドで人物が追加されます。lists show <id>で、まだ追加中かどうかがわかります。追加中のリストにさらに追加する場合は、順番が来るまで待ちます。

スクリプトとエージェントのための設計

  • どのコマンドでも--jsonを付けると、APIの応答をそのまま出力します。
  • 一覧は各ページの下にカーソルを出力します。それを--cursorで渡すか、--allを付けてすべてのページを読み取ります。
  • 書き込みのたびに新しいIdempotency-Keyが付きます。--idempotency-key <key>で独自のキーを指定すると、同じコマンドを再実行しても処理を二重に行わず、最初の応答を返します。
  • 終了コードは、成功は0、エラー(および結果のないfind)は1、キーがないか誤っている場合は2、スコープが不足している場合は3、レート制限または1日の上限に達した場合は4、プランまたは追加のクレジットが必要な場合は5、先に選択が必要で何も変更されなかった場合は6です(campaigns leads addはどの種類のアドレスを追加するかを尋ねます)。
  • 多くの人物やメールボックスを変更するコマンド(leads remove、leads restore、leads move、lists remove-people、inboxes tag、inboxes update)は、先に件数を数えてから確認します。--previewは件数を数えるだけで、--yesは確認を省略します。
  • エラーでは、コード、平易なメッセージ、リクエストIDが出力されます。
  • クレジットを使うコマンドは、ターミナルでは先に確認します。出力先がターミナルでない場合や、--yesまたは--jsonを付けた場合は確認しないため、スクリプトでは-nの値を確認してください。
  • キャンペーンは、IDまたは名前の先頭部分で指定できます。

検索から実行中のキャンペーンまで

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"

このページの内容