CLI Quickstart

Get your affiliate program running in under 5 minutes -- program creation, Stripe webhooks, and live tracking all from your terminal.

Why CLI?Copy Anchor Link

Step 1 -- Create Your ProgramCopy Anchor Link

Run npx affitor init and follow the prompts:

npx affitor init

You'll be asked for:

• Program name -- your product or company name
• Domain -- your root domain (e.g., example.com)
• Commission type -- percentage, fixed, or recurring
• Commission rate -- default is 40% for recurring
• Duration -- how long recurring commissions last (default: 12 months)
• Cookie window -- attribution window in days (default: 90)

After confirming, the CLI creates your program and generates:

.affitor/
  AGENTS.md       -- AI agent instructions (primary, universal standard)
  config.json     -- program ID, settings
  .env            -- API key and secrets (gitignored)
  .env.example    -- env template for teammates and CI
  skills.md       -- tracking code snippets (backward-compat)

Step 2 -- Add Click TrackingCopy Anchor Link

Paste the script tag from the CLI output into your site's <head>:

<script src="https://api.affitor.com/js/affitor-tracker.js"
  data-affitor-program-id="YOUR_PROGRAM_ID">
</script>

Replace YOUR_PROGRAM_ID with the program ID from step 1.

The script auto-detects ?aff=PARTNER_CODE in URLs and stores a first-party cookie for attribution (90-day window by default, set in your program).

Step 3 -- Track SignupsCopy Anchor Link

Call signup() when a user registers:

window.affitor.signup("user_123", "user@example.com");

On new programs the browser call alone is provisional; the server call settles the lead.

Step 4 -- Track PaymentsCopy Anchor Link

Choose your payment tracking method: Server-side tracking vs Stripe integration.

Option A: Stripe integration (automatic)Copy Anchor Link

Connect Stripe in the Affitor dashboard: open the program, go to Settings, and use Connect Stripe. Affitor's own webhook then records sales, renewals and refunds. Add Affitor metadata to your Checkout Session so each sale is attributed; see the Stripe integration guide. The CLI does not connect Stripe (affitor setup stripe only points you to the dashboard).

Option B: Server-side tracking — your backend calls POST /api/v1/track/sale (any payment provider)Copy Anchor Link

curl -X POST https://api.affitor.com/api/v1/track/sale \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer_key": "user_123", "amount_cents": 4900, "currency": "USD"}'

Step 5 -- Test Your IntegrationCopy Anchor Link

Send test events to verify your integration:

npx affitor test click
npx affitor test lead
npx affitor test sale

Then check your program health:

npx affitor status

Non-Interactive ModeCopy Anchor Link

For CI/CD and AI agents, pass --no-interactive --json to skip prompts and get machine-readable output:

npx affitor init \
  --name "My SaaS" \
  --domain example.com \
  --commission-type recurring_percent \
  --commission-rate 30 \
  --duration-months 12 \
  --cookie-duration 90 \
  --no-interactive \
  --json

The commission flags are saved on the program, but partners are paid by the program's Default group commission: set it in the dashboard after init (see CLI commands).

Output is valid JSON, ready for AI agents to parse:

{
  "program_id": 430,
  "api_key": "aff_...",
  "domain": "example.com",
  "status": "created",
  "tracking": {
    "script_tag": "<script src=\"...\"></script>",
    "signup_call": "window.affitor.signup(\"customer_id\", \"email\")",
    "sale_api": "POST https://api.affitor.com/api/v1/track/sale",
    "lead_api": "POST https://api.affitor.com/api/v1/track/lead"
  }
}