Whop CLI - Whop Docs

The Whop CLI (whop) puts the Current API in your terminal: deploy apps, create products, set pricing, send payouts, run ads, and pull stats. Every command also works non-interactively for scripts and AI agents.

The CLI has no sandbox, test, or dry-run mode. Every command runs in production, and many can create real resources or move real money. Commands that mutate state ask for confirmation.

Install

curl -fsSL https://whop.com/install.sh | sh

brew install whopio/tap/whop

npm install -g @whop/cli

Prebuilt binaries cover macOS and Linux. On other platforms, install via npm (requires Node.js 22 or later).

Check the install and see the API version it speaks:

whop --version

whop login

whop login --method oauth opens a browser. whop login --method api-key --apiKey whop_xxx is non-interactive. Profiles let you keep several identities: whop auth list, whop auth switch, and whop auth status manage them. Then pick the business the CLI acts on:

whop quickstart

What’s here

51 command groups, organized the way whop --help groups them:

Category	Groups
Get started	`quickstart` · `apps` · `upgrade`
Commerce	`products` · `plans` · `promo-codes` · `memberships` · `checkout-configurations` · `payment-method-domains` · `shipments`
Core resources	`accounts` · `users` · `team-members` · `members` · `webhooks` · `stats` · `verifications` · `exports`
Money	`payments` · `setup-intents` · `ledgers` · `payouts` · `cards` · `transfers` · `disputes` · `dispute-alerts` · `deposits` · `swaps` · `resolution-center-cases`
Ads	`ads` · `ad-campaigns` · `ad-groups` · `audiences`
Tracking	`people` · `events` · `recommended-actions`
Workforce	`bounties` · `bounty-submissions`
Partners	`partners`
Media	`media`
Identity	`social-accounts`
Developer	`app-builds` · `api-keys` · `permissions` · `files`
Notifications	`notifications`
Auth	`auth` · `login` · `logout`
Integrations	`skills` · `completions`

See Commands for every command, or run whop <group> --help.

Everyday commands

whop --help                  # all commands
whop products list           # what you're selling
whop plans create --help     # options for any command
whop checkout-configurations create --plan_id plan_xxx   # shareable checkout link
whop stats list              # the metric catalog
whop stats get net_revenue --from 2026-01-01 --to 2026-01-31
whop accounts get jordan     # retrieve a business by route

Most groups follow the same shape: whop <resource> list|get|create|update. Every command takes --format json for structured output. Account-scoped commands use the selected business by default, and --account_id chooses a different one.

Deploy an app

whop apps deploy

Builds, type-checks, uploads, and promotes the linked project to production. Pass --preview to upload without promoting, then ship it later with whop apps builds promote <build_id>. Promoting an older build is also how you roll back. After a deploy, read your app’s server logs:

whop apps logs               # recent logs for the linked app
whop apps logs --level error --query "checkout"

Non-interactive use

For CI, scripts, or headless agents, set WHOP_API_KEY instead of logging in. Create a key under Developer in your dashboard, and see Auth & API keys before giving one to an agent.

WHOP_API_KEY=whop_xxx whop products list --format json

The CLI keeps itself up to date in the background. whop upgrade updates immediately.

Next steps

Commands

Every command group, with descriptions from the CLI itself.

Agent mode

Skills sync and the machine-readable flags.

Build with the CLI and Claude

Scaffold and ship a Whop app with an agent in the loop.

Auth & API keys

Scope the credential you sign the CLI in with.

​Install

​Sign in

​What’s here

​Everyday commands

​Deploy an app

​Non-interactive use

​Next steps

Commands

Agent mode

Build with the CLI and Claude

Auth & API keys

Install

Sign in

What’s here

Everyday commands

Deploy an app

Non-interactive use

Next steps