Command-line interface for the Affonso affiliate marketing platform. Manage affiliates, referrals, commissions, payouts, and program settings — from your terminal or through AI agents.
The Affonso CLI is designed for two audiences:
- Developers who want to manage their affiliate program without leaving the terminal
- AI agents (OpenClaw, Paperclip, Claude, GPT, custom agents) that can use shell tools to build automated affiliate workflows — approving affiliates, tracking commissions, managing payouts, and more
Every command supports --json output, making it straightforward for agents to parse responses and chain commands together.
npm install -g @affonso/cliOr run directly with npx:
npx @affonso/cli <command>affonso loginOpens your browser for secure authentication via OAuth 2.1 with PKCE. Tokens are stored locally in ~/.config/affonso/auth.json.
affonso logout# revoke token and clear credentials
affonso whoami # show current auth statusPass it per-command, set it in your environment, or store it in the CLI config:
# Per-command
affonso affiliates list --api-key sk_live_...
# Environment variableexport AFFONSO_API_KEY=sk_live_...
# Store in config
affonso config set api-key sk_live_...Auth priority: --api-key flag > AFFONSO_API_KEY env var > stored config > OAuth token.
affonso <command><subcommand> [options]| Option | Description |
|---|---|
--json | Output as JSON |
--api-key <key> | API key for this request |
--base-url <url> | Custom API base URL |
--no-color | Disable colored output |
--version | Show version |
--help | Show help |
affonso affiliates list [--status pending|approved|rejected] [--search <query>] [--limit <n>] [--page <n>]
affonso affiliates get <id>
affonso affiliates create --name <name> --email <email> --program-id <id>
affonso affiliates update <id> [--name <name>] [--status <status>] [--email <email>]
affonso affiliates delete <id>affonso referrals list [--affiliate-id <id>] [--status <status>] [--limit <n>]
affonso referrals get <id>
affonso referrals create --email <email> --affiliate-id <id>
affonso referrals update <id> [--status <status>] [--email <email>]
affonso referrals delete <id>affonso commissions list [--status <status>] [--affiliate-id <id>] [--limit <n>] [--page <n>]
affonso commissions get <id>
affonso commissions create --referral-id <id> --sale-amount <n> --sale-amount-currency <code> --commission-amount <n> --commission-currency <code>
affonso commissions update <id> [--status <status>] [--sale-amount <n>]
affonso commissions delete <id>affonso coupons list [--affiliate-id <id>] [--search <query>]
affonso coupons get <id>
affonso coupons create --affiliate-id <id> --code <code> --discount-type <type> --discount-value <n> --duration <dur>
affonso coupons delete <id>affonso payouts list [--status <status>] [--affiliate-id <id>]
affonso payouts get <id>
affonso payouts update <id> --status <status>affonso clicks create --program-id <id> --tracking-id <id> [--referrer <url>] [--utm-source <val>]affonso embed-tokens create [--affiliate-id <id>] [--email <email>]affonso program get
affonso program update [--name <name>] [--auto-approve] [--no-auto-approve]
# Sub-resources
affonso program payment-terms get|update
affonso program tracking get|update
affonso program restrictions get|update
affonso program fraud-rules get|update
affonso program portal get|update
affonso program notifications list|update <id>
affonso program groups list|get <id>|create|update <id>|delete <id>
affonso program creatives list|get <id>|create|update <id>|delete <id>affonso marketplace list [--category <cat>] [--search <query>]
affonso marketplace get <id>affonso config get <key># api-key, base-url
affonso config set<key><value>Add --json to any command for machine-readable output:
affonso affiliates list --json
affonso affiliates get aff_123 --jsonThis is especially useful for AI agents that need to parse and act on the data programmatically.
The CLI works as a tool for any AI agent that can execute shell commands. Set AFFONSO_API_KEY in the agent's environment and use --json for structured output:
# An agent can list pending affiliates and approve them
affonso affiliates list --status pending --json
affonso affiliates update aff_123 --status approved --json
# Track and manage commissions
affonso commissions list --affiliate-id aff_123 --json
affonso payouts list --status pending --jsonMIT