@refgrow/cli

@refgrow/cli

Command-line interface for the Refgrow affiliate-program REST API. Manage affiliates, referrals, conversions, and coupons from your shell or CI pipeline.

Install

npm install -g @refgrow/cli

Or one-shot via npx:

npx @refgrow/cli affiliates list

Authenticate

refgrow login

You will be prompted for an API key. Generate one at https://refgrow.com/settings?tab=api-keys. The key is saved to ~/.refgrowrc with mode 600.

Alternatives (in resolution order):

• --api-key <key> flag (one-shot, useful in CI)
• REFGROW_API_KEY env var
• ~/.refgrowrc (from refgrow login)

Verify with:

refgrow whoami

Commands

Affiliates

refgrow affiliates list [--status active|inactive] [--limit 100] [--page 1] [--all]
refgrow affiliates get <email>
refgrow affiliates create <email> [--code XYZ] [--partner-slug s] \
  [--payment-method "USDT TRC-20"] [--payment-details "0xabc..."]
refgrow affiliates update <email> [--email [e-mail]] [--code NEW] \
  [--status active|inactive] [--payout-method paypal|wise|manual] \
  [--paypal-email e] [--payment-method m] [--payment-details d]
refgrow affiliates delete <email> [--yes]

Referrals

refgrow referrals list [--all]
refgrow referrals get <email>
refgrow referrals create <email> --affiliate-id 123 [--status active]
refgrow referrals update <email> [--email [e-mail]] [--affiliate-id 456] [--status s]
refgrow referrals delete <email> [--yes]

Conversions

refgrow conversions list [--type signup|purchase] [--all]
refgrow conversions get <id>
refgrow conversions create --email [e-mail] --type purchase --value 100 \
  [--currency USD] [--affiliate-code CODE] [--reference ord_xyz]
refgrow conversions update <id> [--value 200] [--type signup|purchase] \
  [--reference ref] [--coupon-code CODE] [--paid] [--unpaid]
refgrow conversions delete <id> [--yes]

Coupons

refgrow coupons list [--affiliate-id 123] [--coupon-code XYZ] [--all]
refgrow coupons get <id>
refgrow coupons create --affiliate-id 123 --code XYZ20
refgrow coupons update <id> [--code NEW] [--status active|inactive]
refgrow coupons delete <id> [--yes]

Output formats

By default, list commands print a pretty aligned table. Override with:

• --json — raw JSON, pipe-friendly (refgrow affiliates list --json | jq '.[].user_email')
• --csv — CSV with header row (refgrow affiliates list --csv > affiliates.csv)
• --quiet — drop headers, useful in shell loops

Examples

Export every affiliate to CSV:

refgrow affiliates list --all --csv > affiliates.csv

Bulk-mark a list of conversion ids as paid:

cat conversion-ids.txt | while read id; do
  refgrow conversions update "$id" --paid
done

Record a manual conversion from a Stripe charge:

refgrow conversions create \
  --email "$EMAIL" \
  --type purchase \
  --value "$AMOUNT" \
  --currency USD \
  --reference "$STRIPE_CHARGE_ID"

Find a referral's source affiliate:

refgrow referrals get [e-mail] --json | jq '.affiliate_email'

Exit codes

• 0 — success
• 1 — user error (missing API key, invalid flag)
• 2 — API error (4xx / 5xx response, network failure)

Comparison

Surface	Best for
CLI (refgrow)	Shell scripts, cron jobs, CI, ad-hoc queries
MCP (@refgrow/mcp)	AI assistants (Claude Desktop, Cursor, etc.)
REST API	Custom backend integrations
Zapier / Make / n8n	No-code automation

Links

• Docs: https://refgrow.com/docs/cli
• API reference: https://refgrow.com/docs/api-reference
• Bug reports / feature requests: [e-mail] or the chat widget at https://refgrow.com