@whop/cli 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@whop/cli",
3
- "version": "0.5.0",
3
+ "version": "0.7.0",
4
4
  "description": "The Whop CLI — build and manage Whop apps from your terminal. Human and agent friendly.",
5
5
  "keywords": [
6
6
  "agent",
@@ -21,7 +21,8 @@
21
21
  "whop-cli": "dist/index.js"
22
22
  },
23
23
  "files": [
24
- "dist"
24
+ "dist",
25
+ "skills"
25
26
  ],
26
27
  "type": "module",
27
28
  "exports": {
@@ -44,7 +45,7 @@
44
45
  "devDependencies": {
45
46
  "@types/node": "25.3.5",
46
47
  "fflate": "0.8.2",
47
- "incur": "github:whopio/incur#4b9ca91dc02472db944fb103984ffc4a13251b6f",
48
+ "incur": "github:whopio/incur#fbe3f4dbf48f1bc780cb1bca476f7dade1fe12d3",
48
49
  "tsup": "8.5.0",
49
50
  "tsx": "4.19.4",
50
51
  "typescript": "5.9.3",
@@ -0,0 +1,24 @@
1
+ ---
2
+ name: whop-accounts
3
+ description: "A business on Whop: profile, wallet, capabilities, settings. Run `whop accounts --help` for usage details."
4
+ requires_bin: whop
5
+ command: whop accounts
6
+ ---
7
+
8
+ An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports.
9
+
10
+ Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, and retrieve the account associated with the current API key.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop accounts list` | List Accounts |
17
+ | `whop accounts create` | Create Account |
18
+ | `whop accounts me` | Retrieve Requesting Account |
19
+ | `whop accounts get` | Retrieve Account |
20
+ | `whop accounts update` | Update Account |
21
+ | `whop accounts preferences` | Retrieve Account Preferences |
22
+ | `whop accounts update-preferences` | Update Account Preferences |
23
+
24
+ Run `whop accounts <command> --help` for options, or `whop accounts <command> --schema` for full argument details.
@@ -0,0 +1,24 @@
1
+ ---
2
+ name: whop-ad-campaigns
3
+ description: Platform, objective, and budget for a set of ads. Run `whop ad-campaigns --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop ad-campaigns
6
+ ---
7
+
8
+ An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](https://docs.whop.com/api-reference/beta/ad-groups/ad-group) and ads.
9
+
10
+ Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop ad-campaigns list` | List Ad Campaigns |
17
+ | `whop ad-campaigns create` | Create an Ad Campaign |
18
+ | `whop ad-campaigns delete` | Delete an Ad Campaign |
19
+ | `whop ad-campaigns get` | Retrieve an Ad Campaign |
20
+ | `whop ad-campaigns update` | Update an Ad Campaign |
21
+ | `whop ad-campaigns pause` | Pause an Ad Campaign |
22
+ | `whop ad-campaigns unpause` | Unpause an Ad Campaign |
23
+
24
+ Run `whop ad-campaigns <command> --help` for options, or `whop ad-campaigns <command> --schema` for full argument details.
@@ -0,0 +1,24 @@
1
+ ---
2
+ name: whop-ad-groups
3
+ description: Audience, placements, and schedule within a campaign. Run `whop ad-groups --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop ad-groups
6
+ ---
7
+
8
+ An Ad Group sits inside an [ad campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](https://docs.whop.com/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads.
9
+
10
+ Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop ad-groups list` | List Ad Groups |
17
+ | `whop ad-groups create` | Create an Ad Group |
18
+ | `whop ad-groups delete` | Delete an Ad Group |
19
+ | `whop ad-groups get` | Retrieve an Ad Group |
20
+ | `whop ad-groups update` | Update an Ad Group |
21
+ | `whop ad-groups pause` | Pause an Ad Group |
22
+ | `whop ad-groups unpause` | Unpause an Ad Group |
23
+
24
+ Run `whop ad-groups <command> --help` for options, or `whop ad-groups <command> --schema` for full argument details.
@@ -0,0 +1,100 @@
1
+ ---
2
+ name: whop-ads
3
+ description: "The creative: copy, assets, and destination URL. Run `whop ads --help` for usage details."
4
+ requires_bin: whop
5
+ command: whop ads
6
+ ---
7
+
8
+ An Ad is the individual creative unit delivered by an [ad group](https://docs.whop.com/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad.
9
+
10
+ Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop ads list` | List Ads |
17
+ | `whop ads create` | Create an Ad |
18
+ | `whop ads delete` | Delete an Ad |
19
+ | `whop ads get` | Retrieve an Ad |
20
+ | `whop ads update` | Update an Ad |
21
+ | `whop ads pause` | Pause an Ad |
22
+ | `whop ads unpause` | Unpause an Ad |
23
+
24
+ Run `whop ads <command> --help` for options, or `whop ads <command> --schema` for full argument details.
25
+
26
+ ## Launch playbook — from nothing to a live ad
27
+
28
+ Three commands take you from nothing to a launchable ad: generate a creative, create the campaign + ad group + ad in one request, then flip the campaign to active. Structured flags (`--ad_group`, `--creatives`, `--ads_payment_methods`) take JSON strings.
29
+
30
+ ### One-time setup
31
+
32
+ 1. **Auth** — `whop login` (OAuth). First-time billing setup requires a user login; an API key can only reorder already-configured payment methods. If a command fails with a scope error saying your login predates the scope, run `whop login` again.
33
+ 2. **Facebook page** — `whop social-accounts list` must show a `"platform": "facebook"` entry. Three ways to get one:
34
+ - **Already connected** — use its `sacc_` id as-is.
35
+ - **Link a Meta Business account** — `whop social-accounts connect --platform meta_business --scopes '["advertise"]' --redirect_url <url>`, then send the user to the returned `authorize_url`.
36
+ - **No page at all** — have Whop create one for the account: `whop social-accounts create --platform facebook`.
37
+ 3. **Ads payment method** — check with `whop accounts preferences <account_id>` (your `biz_` ID, from `whop accounts me`). If `ads_payment_methods` is null, configure balance billing:
38
+
39
+ ```sh
40
+ whop accounts update-preferences <account_id> --ads_payment_methods '{"primary": {"type": "platform_balance"}}'
41
+ ```
42
+
43
+ Only launching needs this — drafts work without. Fund the balance with `whop deposits create --amount 50` (returns a hosted deposit page URL).
44
+
45
+ ### 1. Generate a creative
46
+
47
+ ```sh
48
+ whop media generate --type image --prompt "A running club jogging across a bridge at sunrise, warm light" --wait
49
+ ```
50
+
51
+ `--wait` blocks until the asset is terminal and returns `file.id` — use that as the creative. Billed from the balance (`amount_charged`); a failed generation auto-refunds, so adjust the prompt and retry. Video: `--type video` plus optional `--duration_seconds` (5/10/15), `--resolution` (480p–4k), and up to 4 `--reference_media` file IDs (first one seeds the opening frame).
52
+
53
+ ### 2. Create the whole tree as a draft — one request
54
+
55
+ ```sh
56
+ whop ads create \
57
+ --title "Run club launch ad" \
58
+ --primary_texts "Join 10,000 runners chasing their next PR together." \
59
+ --headlines "Find your stride" \
60
+ --call_to_action sign_up \
61
+ --url "https://whop.com/your-store-page" \
62
+ --creatives '[{"id": "file_XXXXXXXX"}]' \
63
+ --social_accounts '[{"id": "sacc_XXXXXXXX"}]' \
64
+ --ad_group '{
65
+ "title": "US broad",
66
+ "conversion_location": "website",
67
+ "regions": {"include": {"countries": ["US"]}},
68
+ "ad_campaign": {"title": "Run club growth", "platform": "meta", "objective": "sales", "status": "draft", "budget_amount": 25, "budget_optimization": "ad_campaign"}
69
+ }'
70
+ ```
71
+
72
+ Field rules:
73
+
74
+ | Field | Rule |
75
+ |-------|------|
76
+ | `creatives` | One entry with no `format` is required (the base asset). `square`/`vertical`/`horizontal` are optional crops on top. |
77
+ | `url` | Required for website ads. A whop.com store page works as-is; an external page needs the Whop pixel installed. |
78
+ | Budget | Default to CBO: `budget_amount` on the campaign with `budget_optimization: "ad_campaign"` (the network shifts spend to the best ad group). Per-ad-group `budget_amount` (ABO) is the manual alternative. One level owns it — never both. |
79
+ | Targeting | Omit `demographics`/`placements`/`devices` for automatic optimization. `regions` uses ISO 3166 (`"US"`, `"US-CA"`). |
80
+ | `lead_form` | Only with an instant-form `conversion_location`. |
81
+
82
+ Reuse existing containers by passing `--ad_group_id adgrp_x` instead of `--ad_group`, or `"ad_campaign_id": "adcamp_x"` inside `--ad_group` instead of the inline `ad_campaign`.
83
+
84
+ ### 3. Launch
85
+
86
+ `"status": "draft"` above kept money out of it. Review, then launch — this is when spend starts and the payment method is enforced:
87
+
88
+ ```sh
89
+ whop ad-campaigns update adcamp_XXXXXXXX --status active
90
+ ```
91
+
92
+ (Ready to spend immediately? Omit `"status": "draft"` and the one-shot create launches directly.)
93
+
94
+ ### 4. Monitor
95
+
96
+ ```sh
97
+ whop ads get ad_XXXXXXXX
98
+ ```
99
+
100
+ `delivery_status` is the live state (a brief `in_review` for moderation is normal); `issues[]` carries a human-readable `message` for anything the network rejected asynchronously. Control delivery with `pause`/`unpause` on ads, ad groups, or campaigns. Edit copy or creatives with `whop ads update` — sending `creatives` replaces the whole set, so include the base entry.
@@ -0,0 +1,18 @@
1
+ ---
2
+ name: whop-apps
3
+ description: "Apps you build on Whop: metadata, hosted builds, runtime logs. Run `whop apps --help` for usage details."
4
+ requires_bin: whop
5
+ command: whop apps
6
+ ---
7
+
8
+ An App is software you build on the Whop platform — from a fully-hosted web app served at `<route>.whop.app` to an API integration installed into whops as experiences. Apps belong to an account and hold their own credentials and settings.
9
+
10
+ Use the Apps API to create and configure apps, and — for hosted apps — read their server runtime logs: every console line, uncaught exception, and failed request is captured for 7 days and queryable by build, level, time window, and message text.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop apps logs` | List App Logs |
17
+
18
+ Run `whop apps <command> --help` for options, or `whop apps <command> --schema` for full argument details.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: whop-audiences
3
+ description: Reusable targeting lists for ad groups. Run `whop audiences --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop audiences
6
+ ---
7
+
8
+ An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences.
9
+
10
+ Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop audiences list` | List Audiences |
17
+ | `whop audiences create` | Create Audience |
18
+ | `whop audiences delete` | Delete Audience |
19
+
20
+ Run `whop audiences <command> --help` for options, or `whop audiences <command> --schema` for full argument details.
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: whop-cards
3
+ description: Issue cards that spend from a balance. Run `whop cards --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop cards
6
+ ---
7
+
8
+ Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending.
9
+
10
+ Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop cards list` | List Cards |
17
+ | `whop cards create` | Create Card |
18
+ | `whop cards get` | Retrieve Card |
19
+ | `whop cards update` | Update Card |
20
+
21
+ Run `whop cards <command> --help` for options, or `whop cards <command> --schema` for full argument details.
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: whop-checkout-configurations
3
+ description: Turn a plan into a shareable, prefilled checkout link. Run `whop checkout-configurations --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop checkout-configurations
6
+ ---
7
+
8
+ A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout.
9
+
10
+ Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop checkout-configurations list` | List checkout configurations |
17
+ | `whop checkout-configurations create` | Create a checkout configuration |
18
+ | `whop checkout-configurations delete` | Delete a checkout configuration |
19
+ | `whop checkout-configurations get` | Retrieve a checkout configuration |
20
+
21
+ Run `whop checkout-configurations <command> --help` for options, or `whop checkout-configurations <command> --schema` for full argument details.
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: whop-deposits
3
+ description: Add funds to a balance. Run `whop deposits --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop deposits
6
+ ---
7
+
8
+ Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses.
9
+
10
+ Use the Deposits API to create deposit instructions for an account and retrieve existing bank deposit activity.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop deposits list` | Retrieve Deposits |
17
+ | `whop deposits create` | Create Deposit |
18
+
19
+ Run `whop deposits <command> --help` for options, or `whop deposits <command> --schema` for full argument details.
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: whop-events
3
+ description: Conversion and engagement events tracked for attribution. Run `whop events --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop events
6
+ ---
7
+
8
+ An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](https://docs.whop.com/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it.
9
+
10
+ Use the Events API to send new tracking events and list the events recorded for a person.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop events list` | List Events |
17
+ | `whop events create` | Create Event |
18
+
19
+ Run `whop events <command> --help` for options, or `whop events <command> --schema` for full argument details.
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: whop-ledgers
3
+ description: The activity feed behind an account or user's balance. Run `whop ledgers --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop ledgers
6
+ ---
7
+
8
+ A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups.
9
+
10
+ Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop ledgers list` | List Financial Activity |
17
+ | `whop ledgers report` | Get Financial Report |
18
+
19
+ Run `whop ledgers <command> --help` for options, or `whop ledgers <command> --schema` for full argument details.
@@ -0,0 +1,23 @@
1
+ ---
2
+ name: whop-media
3
+ description: AI-generated assets, billed from a balance, attachable wherever files are accepted. Run `whop media --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop media
6
+ ---
7
+
8
+ A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files.
9
+
10
+ Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop media generate` | Generate Media Asset |
17
+ | `whop media get` | Retrieve Media Asset |
18
+
19
+ Run `whop media <command> --help` for options, or `whop media <command> --schema` for full argument details.
20
+
21
+ ## Steps that finish in the browser
22
+
23
+ Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: whop-payouts
3
+ description: Send money from a balance to a bank or wallet. Run `whop payouts --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop payouts
6
+ ---
7
+
8
+ Payouts represent money sent from an account balance to an external destination, such as a bank account or other supported payout method.
9
+
10
+ Use the Payouts API to list payout history, monitor payout statuses, and show expected arrival details for funds leaving an account.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop payouts list` | List Payouts |
17
+ | `whop payouts create` | Create Payout |
18
+ | `whop payouts methods` | List Payout Methods |
19
+
20
+ Run `whop payouts <command> --help` for options, or `whop payouts <command> --schema` for full argument details.
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: whop-people
3
+ description: Visitors and customers of an account, aggregated from pixel events. Run `whop people --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop people
6
+ ---
7
+
8
+ A Person represents a visitor or customer of an account, assembled from [pixel events](https://docs.whop.com/api-reference/beta/events/event) and purchase activity — ad clicks, storefront visits, and checkouts.
9
+
10
+ Use the People API to list the people of an account and retrieve a single person.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop people list` | List People |
17
+ | `whop people get` | Retrieve Person |
18
+
19
+ Run `whop people <command> --help` for options, or `whop people <command> --schema` for full argument details.
@@ -0,0 +1,23 @@
1
+ ---
2
+ name: whop-plans
3
+ description: "Pricing for a product: one-time, recurring, trials, stock. Run `whop plans --help` for usage details."
4
+ requires_bin: whop
5
+ command: whop plans
6
+ ---
7
+
8
+ A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility.
9
+
10
+ Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop plans list` | List Plans |
17
+ | `whop plans create` | Create Plan |
18
+ | `whop plans delete` | Delete Plan |
19
+ | `whop plans get` | Retrieve Plan |
20
+ | `whop plans update` | Update Plan |
21
+ | `whop plans calculate_tax` | Calculate Tax |
22
+
23
+ Run `whop plans <command> --help` for options, or `whop plans <command> --schema` for full argument details.
@@ -0,0 +1,22 @@
1
+ ---
2
+ name: whop-products
3
+ description: The things you sell. Each owns plans and a store page. Run `whop products --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop products
6
+ ---
7
+
8
+ A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery.
9
+
10
+ Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop products list` | List Products |
17
+ | `whop products create` | Create Product |
18
+ | `whop products delete` | Delete Product |
19
+ | `whop products get` | Retrieve Product |
20
+ | `whop products update` | Update Product |
21
+
22
+ Run `whop products <command> --help` for options, or `whop products <command> --schema` for full argument details.
@@ -0,0 +1,22 @@
1
+ ---
2
+ name: whop-referrals
3
+ description: Track who referred a purchase and what they earn. Run `whop referrals --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop referrals
6
+ ---
7
+
8
+ Referrals track businesses referred to Whop and the earnings generated from their processing volume. They help you see how much volume your referred businesses have processed and how much you've earned from them.
9
+
10
+ Use the Referrals API to list referred businesses, retrieve one referral, and review earnings across all referrals or for a single referred business.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop referrals list` | List business referrals |
17
+ | `whop referrals businesses-leaderboard` | Retrieve the business referral leaderboard |
18
+ | `whop referrals get` | Retrieve a business referral |
19
+ | `whop referrals earnings` | List a business referral's earnings |
20
+ | `whop referrals partners` | Enroll as a Whop partner |
21
+
22
+ Run `whop referrals <command> --help` for options, or `whop referrals <command> --schema` for full argument details.
@@ -0,0 +1,26 @@
1
+ ---
2
+ name: whop-social-accounts
3
+ description: Connected Facebook and Instagram accounts that run ads. Run `whop social-accounts --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop social-accounts
6
+ ---
7
+
8
+ A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](https://docs.whop.com/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts.
9
+
10
+ Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop social-accounts list` | List Social Accounts |
17
+ | `whop social-accounts create` | Create a Social Account |
18
+ | `whop social-accounts connect` | Connect a Social Account |
19
+ | `whop social-accounts delete` | Delete a Social Account |
20
+ | `whop social-accounts posts` | List Social Account Posts |
21
+
22
+ Run `whop social-accounts <command> --help` for options, or `whop social-accounts <command> --schema` for full argument details.
23
+
24
+ ## Steps that finish in the browser
25
+
26
+ Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: whop-swaps
3
+ description: Convert a balance between currencies. Run `whop swaps --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop swaps
6
+ ---
7
+
8
+ Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap.
9
+
10
+ Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop swaps status` | List Swaps |
17
+ | `whop swaps create` | Create Swap |
18
+ | `whop swaps quote` | Create Swap Quote |
19
+ | `whop swaps get` | Retrieve Swap |
20
+
21
+ Run `whop swaps <command> --help` for options, or `whop swaps <command> --schema` for full argument details.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: whop-transfers
3
+ description: Move funds between Whop accounts and users. Run `whop transfers --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop transfers
6
+ ---
7
+
8
+ Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type.
9
+
10
+ Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop transfers list` | List Transfers |
17
+ | `whop transfers create` | Create Transfer |
18
+ | `whop transfers get` | Retrieve Transfer |
19
+
20
+ Run `whop transfers <command> --help` for options, or `whop transfers <command> --schema` for full argument details.
@@ -0,0 +1,22 @@
1
+ ---
2
+ name: whop-users
3
+ description: "A person on Whop: profile and connected identities. Run `whop users --help` for usage details."
4
+ requires_bin: whop
5
+ command: whop users
6
+ ---
7
+
8
+ A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences.
9
+
10
+ Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience.
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop users list` | List Users |
17
+ | `whop users me` | Update Current User |
18
+ | `whop users get` | Retrieve User |
19
+ | `whop users update` | Update User |
20
+ | `whop users access` | Check User Access |
21
+
22
+ Run `whop users <command> --help` for options, or `whop users <command> --schema` for full argument details.
@@ -0,0 +1,25 @@
1
+ ---
2
+ name: whop-verifications
3
+ description: Identity review required before payouts and card issuing. Run `whop verifications --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop verifications
6
+ ---
7
+
8
+ A Verification represents an identity review for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows.
9
+
10
+ Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](https://docs.whop.com/api-reference/beta/verifications/update-verification).
11
+
12
+ ## Commands
13
+
14
+ | Command | Description |
15
+ |---------|-------------|
16
+ | `whop verifications list` | List Verifications |
17
+ | `whop verifications create` | Create Verification |
18
+ | `whop verifications get` | Retrieve Verification |
19
+ | `whop verifications update` | Update Verification |
20
+
21
+ Run `whop verifications <command> --help` for options, or `whop verifications <command> --schema` for full argument details.
22
+
23
+ ## Steps that finish in the browser
24
+
25
+ Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.