Official Sweeppea CLI · Rust
Run your sweepstakes
from the terminal.
A single native binary — instant startup, no runtime to install. Manage sweepstakes, participants, winners and 12 more resources over the Sweeppea API v3, straight from your shell or CI.
$ npx @sweeppea/cli auth login Paste your API key (hidden): •••••••••••• ✓ key validated · stored in your OS keyring $ npx @sweeppea/cli account health API is healthy $ npx @sweeppea/cli winners draw $SWEEP --winners 3 This immediately draws 3 winner(s) and cannot be undone. Continue? [y/N]
Install
No runtime required — the package ships a native binary per platform, and npm installs only the one matching your OS and CPU.
$ npx @sweeppea/cli auth login # run on demand $ npm install -g @sweeppea/cli # or install the `sweeppea` command $ sweeppea --version # → sweeppea 0.9.0
Authentication & Pricing
Requires an active subscription
This CLI connects with a Sweeppea API Key tied to an active subscription. Running sweepstakes in the US and Canada is legally complex — per-state registration, bonding thresholds, void-where-prohibited rules, prize disclosure and compliant official rules.
Sweeppea handles that for you: it generates legally compliant official rules, manages multi-state eligibility, enforces entry limits, and keeps an auditable record of every participant and winner draw. Your API Key isn't just authentication — it's access to a system built to keep sweepstakes legally defensible.
- Create an account at sweeppea.com
- Choose a plan that fits your needs
- Get your API Key from the API dashboard (API Keys tab)
- Store it:
sweeppea auth login— validated before saving, kept in your OS keyring
Commands
Full parity with the Sweeppea MCP server — 13 resource categories. Destructive actions confirm first and honor --yes; every command supports --json.
$ sweeppea auth
Store, verify and remove your API key.
$ sweeppea account
Connectivity, profile, business info and plan.
$ sweeppea sweepstakes
Create, edit, clone, pause and delete sweepstakes.
$ sweeppea participants
Add, look up, count and manage entrants.
$ sweeppea winners
Draw now or schedule future drawings.
$ sweeppea groups
Organize entrants into groups.
$ sweeppea notes
Keep account-level notes.
$ sweeppea calendar
Manage calendar events.
$ sweeppea rules
Publish official-rules documents.
$ sweeppea files
Upload, share and manage drive files.
$ sweeppea billing
Wallet, billing and usage totals.
$ sweeppea tickets
Open, edit, resolve and close support tickets.
$ sweeppea todos
Manage to-dos.
$ sweeppea invoices
Bill clients: draft, issue, cancel and delete invoices.
$ sweeppea surveys
Survey entrants and read the answers back.
The Sweeppea developer ecosystem
Three ways to drive the same platform. All of them speak to the Sweeppea API v3 and use the same API key.
❯ CLI
A native binary for your shell and CI. Scriptable, --json everywhere.
◆ MCP Server
71 tools for AI assistants — Claude, Cursor, Windsurf, Gemini CLI and more.
mcpdocs.sweeppea.com ↗▮ REST API v3
The HTTP endpoints underneath it all, with a full OpenAPI specification.
apidocs.sweeppea.com ↗For AI agents
An official skill that teaches an agent this CLI — and the compliance rules the CLI itself does not enforce.
The CLI is the deterministic floor an agent can stand on: real commands, local validation, human confirmation on anything irreversible, and --json everywhere. The official Agent Skill teaches it the command surface and the API's behaviour under load.
It also carries something the CLI cannot: the US and Canada sweepstakes compliance rules. The MCP server enforces those server-side before a tool runs — illegal lotteries, COPPA, alcohol age gates. The CLI validates formats only, so an agent driving it becomes the guardrail. The skill is what makes that safe.
Other agents activate it differently — claude.ai takes a zip, the API takes an upload, and Codex, Cursor, Windsurf, Copilot and Gemini CLI read an AGENTS.md pointer. Full activation guide →
What it knows
Every command and flag, read from the binary itself. Pagination, retry and gateway behaviour. The exact gap between the CLI and the MCP — and where to route a task the CLI cannot do.
Compliance
Official rules, AMOE, age gates, state registration thresholds, and the categories to refuse outright. Consulted before creating a sweepstakes or drawing winners.
Built to be safe
Security
Your key never leaks. Stored in the OS keyring (Keychain / Credential Manager) with a 0600 file fallback on Linux. Never logged, never printed. HTTPS only.
No surprises
Irreversible actions confirm first. delete and winners draw ask before acting, honor --yes, and abort in a non-interactive shell unless you opt in.