rewardful-cli
v0.1.4
Published
CLI and MCP server for the Rewardful affiliate tracking API — agent-native tool for managing affiliates, campaigns, commissions, payouts, and referral links
Downloads
500
Maintainers
Readme
rewardful-cli
CLI and MCP server for the Rewardful affiliate tracking API — agent-native tool for managing affiliates, campaigns, commissions, payouts, and referral links.
Installation
npm install -g rewardful-cliAuth
Get your API secret from Rewardful Dashboard → Settings → API.
export REWARDFUL_API_SECRET=your_api_secret_hereUsage
rewardful <group> <subcommand> [options]Groups
| Group | Description |
|-------|-------------|
| affiliates | Manage affiliates (list, create, get, update, sso) |
| campaigns | Manage campaigns (list, create, get, update) |
| referrals | View referrals (list, get) |
| commissions | Manage commissions (list, get, update, delete) |
| payouts | Manage payouts (list, get, mark-paid) |
| links | Manage affiliate links (list, create, get, update) |
Examples
# List all affiliates
rewardful affiliates list --pretty
# Create an affiliate
rewardful affiliates create --first-name Jane --last-name Doe --email [email protected]
# Generate SSO magic link
rewardful affiliates sso <affiliate-id>
# List due commissions
rewardful commissions list --state due
# Mark a payout as paid
rewardful payouts mark-paid <payout-id>
# List referral links for an affiliate
rewardful links list --affiliate-id <id>Global flags
--api-secret <secret> Rewardful API secret (overrides REWARDFUL_API_SECRET)
--pretty Pretty-print JSON output
--quiet Suppress output, exit code only
--fields a,b.c Filter output to specific fieldsMCP Server
Use as an MCP server for AI agents (Claude, etc.):
{
"mcpServers": {
"rewardful": {
"command": "npx",
"args": ["rewardful-cli/dist/mcp.js"],
"env": {
"REWARDFUL_API_SECRET": "your_api_secret_here"
}
}
}
}See AGENTS.md for the full agent guide including all 22 commands, response shapes, workflows, and MCP tool names.
License
MIT
