@whop/cli 0.16.0 → 0.16.2

package/skills/whop-ads/SKILL.md

@@ -1,277 +0,0 @@
----
-name: whop-ads
-description: "The creative: copy, assets, and destination URL. Run `whop ads --help` for usage details."
-requires_bin: whop
-command: whop ads
----
-
-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.
-
-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.
-
-# whop ads create
-
-Create an Ad
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--ad_group` | `object` | no |  | An inline ad group to create (same shape as POST /ad_groups, including ad_campaign_id). Creates the ad group and the ad together. Provide this OR ad_group_id. |
-| `--ad_group_id` | `string` | no |  | The existing ad group to create the ad in. Provide this OR ad_group, not both. |
-| `--call_to_action` | `string` | no |  | The call-to-action button shown on the ad. |
-| `--creatives` | `array` | no |  | The ad's creative assets. Each entry is an uploaded file id with an optional format; omit format for the original asset. Two or more entries with no format become a carousel (2-10 attachments), in order, sharing the ad's copy. |
-| `--descriptions` | `array` | no |  | The description variants shown on the ad. |
-| `--headlines` | `array` | no |  | The headline variants shown on the ad. |
-| `--lead_form` | `object` | no |  | Instant lead form for the ad. Only allowed when the ad group's conversion_location is an instant-form destination (instant_forms, instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with lead_form_id. |
-| `--lead_form_id` | `string` | no |  | Use an existing instant form instead of creating one — the form's platform ID, from a form already on the ad's Facebook page. Only allowed when the ad group's conversion_location is an instant-form destination. Mutually exclusive with lead_form. |
-| `--messaging_config` | `object` | no |  | Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt (keyword). |
-| `--multi_advertiser_ads` | `boolean` | no |  | Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true. |
-| `--post_id` | `string` | no |  | Promote an existing post instead of uploading creatives — a Facebook post or Instagram media id. Mutually exclusive with creatives. Pair with post_source. |
-| `--post_source` | `string` | no |  | Identifies the network that owns `post_id`. The source is inferred from the ID shape when omitted. |
-| `--primary_texts` | `array` | no |  | The primary text variants shown in the ad body. |
-| `--social_accounts` | `array` | no |  | The social accounts the ad runs under — a connected Facebook page and, optionally, an Instagram profile. |
-| `--title` | `string` | no |  | The display name of the ad. |
-| `--url` | `string` | no |  | The URL the ad links to. |
-| `--url_parameters` | `object` | no |  | Query parameters appended to the destination URL, keyed by parameter name. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads delete
-
-Delete an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads duplicate
-
-Duplicate an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--count` | `number` | no |  | Number of copies to create (1-10). Defaults to 1. |
-| `--preserve_engagement` | `boolean` | no |  | Whether the copies keep the original post's engagement (likes, comments, shares). Defaults to false. |
-| `--target_ad_group_id` | `string` | no |  | Ad group to duplicate into. Defaults to the ad's own ad group. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads get
-
-Retrieve an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--stats_from` | `string` | no |  | Start of the stats window. |
-| `--stats_to` | `string` | no |  | End of the stats window. |
-| `--time_zone` | `string` | no |  | IANA timezone the stats window is interpreted in. Defaults to UTC. |
-| `--attribution_model` | `string` | no |  | Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise. |
-
----
-
-# whop ads list
-
-List Ads
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | The account the ads belong to. Defaults to the account-scoped key's own account. |
-| `--ad_campaign_id` | `string` | no |  | Only return ads in this ad campaign. |
-| `--ad_campaign_ids` | `array` | no |  | Only return ads in these ad campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b). |
-| `--ad_group_id` | `string` | no |  | Only return ads in this ad group. |
-| `--ad_group_ids` | `array` | no |  | Only return ads in these ad groups (max 100). Repeat the parameter for each id (ad_group_ids=a&ad_group_ids=b). |
-| `--status` | `string` | no |  | Only return ads with this status. |
-| `--query` | `string` | no |  | Filter ads by a title or ID substring. |
-| `--order` | `string` | no |  | The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports. |
-| `--direction` | `string` | no |  | The sort direction. Defaults to desc. |
-| `--created_before` | `string` | no |  | Only return ads created before this timestamp. |
-| `--created_after` | `string` | no |  | Only return ads created after this timestamp. |
-| `--stats_from` | `string` | no |  | Start of the stats window. Defaults to all-time. |
-| `--stats_to` | `string` | no |  | End of the stats window. Defaults to now. |
-| `--time_zone` | `string` | no |  | IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare stats_from/stats_to dates resolve to day boundaries on this clock. Defaults to UTC. |
-| `--attribution_model` | `string` | no |  | Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise. |
-| `--first` | `number` | no | `20` | The number of ads to return. |
-| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
-| `--last` | `number` | no |  | The number of ads to return from the end of the range. |
-| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |
-
----
-
-# whop ads pause
-
-Pause an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads unpause
-
-Unpause an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads update
-
-Update an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--call_to_action` | `string` | no |  | The call-to-action button shown on the ad. |
-| `--creatives` | `array` | no |  | The ad's creative assets. Each entry is an uploaded file id with an optional format; omit format for the original asset. Replaces a live ad's creative on the platform. Two or more entries with no format replace it with a carousel (2-10 attachments), in order, sharing the ad's copy. |
-| `--descriptions` | `array` | no |  | The description variants shown on the ad. |
-| `--headlines` | `array` | no |  | The headline variants shown on the ad. |
-| `--lead_form` | `object` | no |  | Instant lead form for the ad. Only allowed when the ad group's conversion_location is an instant-form destination (instant_forms, instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with lead_form_id. |
-| `--lead_form_id` | `string` | no |  | Use an existing instant form instead of creating one — the form's platform ID, from a form already on the ad's Facebook page. Only allowed when the ad group's conversion_location is an instant-form destination. Mutually exclusive with lead_form. Replaces a stored lead_form. |
-| `--messaging_config` | `object` | no |  | Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt (keyword). |
-| `--multi_advertiser_ads` | `boolean` | no |  | Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true. |
-| `--post_id` | `string` | no |  | Promote an existing post instead of uploading creatives — a Facebook post or Instagram media id. Mutually exclusive with creatives. Pair with post_source. |
-| `--post_source` | `string` | no |  | Identifies the network that owns `post_id`. The source is inferred from the ID shape when omitted. |
-| `--primary_texts` | `array` | no |  | The primary text variants shown in the ad body. |
-| `--social_accounts` | `array` | no |  | The social accounts the ad runs under — a connected Facebook page and, optionally, an Instagram profile. |
-| `--title` | `string` | no |  | The display name of the ad. |
-| `--url` | `string` | no |  | The URL the ad links to. |
-| `--url_parameters` | `object` | no |  | Query parameters appended to the destination URL, keyed by parameter name. |
-
-> Confirm with the user before executing this destructive command.
-
-## Launch playbook — from nothing to a live ad
-
-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.
-
-### One-time setup
-
-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.
-2. **Facebook page** — `whop social-accounts list` must show a `"platform": "facebook"` entry. Three ways to get one:
-   - **Already connected** — use its `sacc_` id as-is.
-   - **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`.
-   - **No page at all** — have Whop create one for the account: `whop social-accounts create --platform facebook`.
-3. **Ads payment method** — check with `whop accounts preferences --account_id <account_id>` (your `biz_` ID, from `whop accounts me`). If `ads_payment_methods` is null, configure balance billing:
-
-   ```sh
-   whop accounts update-preferences --account_id <account_id> --ads_payment_methods '{"primary": {"type": "platform_balance"}}'
-   ```
-
-   Only launching needs this — drafts work without. Fund the balance with `whop deposits create --amount 50` (returns a hosted deposit page URL).
-
-### 1. Generate a creative
-
-```sh
-whop media generate --type image --prompt "A running club jogging across a bridge at sunrise, warm light" --wait
-```
-
-`--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).
-
-### 2. Create the whole tree as a draft — one request
-
-```sh
-whop ads create \
-  --title "Run club launch ad" \
-  --primary_texts "Join 10,000 runners chasing their next PR together." \
-  --headlines "Find your stride" \
-  --call_to_action sign_up \
-  --url "https://whop.com/your-store-page" \
-  --creatives '[{"id": "file_XXXXXXXX"}]' \
-  --social_accounts '[{"id": "sacc_XXXXXXXX"}]' \
-  --ad_group '{
-    "title": "US broad",
-    "conversion_location": "website",
-    "regions": {"include": {"countries": ["US"]}},
-    "ad_campaign": {"title": "Run club growth", "platform": "meta", "objective": "sales", "status": "draft", "budget_amount": 25, "budget_optimization": "ad_campaign"}
-  }'
-```
-
-Field rules:
-
-| Field | Rule |
-|-------|------|
-| `creatives` | One entry with no `format` is required (the base asset). `square`/`vertical`/`horizontal` are optional crops on top. |
-| `url` | Required for website ads. A whop.com store page works as-is; an external page needs the Whop pixel installed. |
-| 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. |
-| Targeting | Omit `demographics`/`placements`/`devices` for automatic optimization. `regions` uses ISO 3166 (`"US"`, `"US-CA"`). |
-| `lead_form` | Only with an instant-form `conversion_location`. |
-
-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`.
-
-### 3. Launch
-
-`"status": "draft"` above kept money out of it. Review, then launch — this is when spend starts and the payment method is enforced:
-
-```sh
-whop ad-campaigns update adcamp_XXXXXXXX --status active
-```
-
-(Ready to spend immediately? Omit `"status": "draft"` and the one-shot create launches directly.)
-
-### 4. Monitor
-
-```sh
-whop ads get ad_XXXXXXXX
-```
-
-`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.

package/skills/whop-api-keys/SKILL.md

@@ -1,126 +0,0 @@
----
-name: whop-api-keys
-description: Programmatic credentials for an account or app. Run `whop api-keys --help` for usage details.
-requires_bin: whop
-command: whop api-keys
----
-
-An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist.
-
-Use the API Keys API to list an account or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key.
-
-# whop api-keys create
-
-Create API Key
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--api_version_date` | `string` | no |  | Dated API version used when requests authenticated with this key omit the `Api-Version-Date` header. New keys default to the latest version. |
-| `--expires_at` | `unknown` | no |  | When the API key should stop working, as an ISO 8601 timestamp. Omit (or pass `null` on update) for a key that never expires. |
-| `--ip_allowlist` | `unknown` | no |  | IPv4/IPv6 CIDR ranges allowed to use this key, for example `["203.0.113.0/24"]`. Empty or `null` allows any IP. |
-| `--name` | `string` | yes |  | A human-readable name for the API key, such as 'Production API Key'. |
-| `--permissions` | `object` | yes |  | The permissions policy for the API key: explicit permission statements, or a system role to inherit from. Statements without a `resources` array default to the owning account (Account API keys) or every key-addressable resource (App API keys). |
-| `--resource_id` | `string` | yes |  | The account (`biz_`) or app (`app_`) tag to create the API key for. |
-| `--resource_type` | `string` | yes |  | The type of resource that will own this API key. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop api-keys delete
-
-Delete API Key
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | API key ID, prefixed `apik_`. |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop api-keys get
-
-Retrieve API Key
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | API key ID, prefixed `apik_`. |
-
----
-
-# whop api-keys list
-
-List API Keys
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--resource_id` | `string` | yes |  | The account (`biz_`) or app (`app_`) tag to list API keys for. |
-| `--resource_type` | `string` | yes |  | The type of resource that owns the API keys. |
-| `--created_before` | `number` | no |  | Only return API keys created before this ISO 8601 timestamp. |
-| `--created_after` | `number` | no |  | Only return API keys created after this ISO 8601 timestamp. |
-| `--first` | `number` | no |  | The number of API keys to return (default 20, max 100). |
-| `--after` | `string` | no |  | A cursor; returns API keys after this position. |
-| `--last` | `number` | no |  | The number of API keys to return from the end of the range. |
-| `--before` | `string` | no |  | A cursor; returns API keys before this position. |
-| `--order` | `string` | no |  | The field to sort API keys by. |
-| `--direction` | `string` | no |  | Sort direction. |
-
----
-
-# whop api-keys permissions
-
-List the Permission Catalog
-
----
-
-# whop api-keys rotate
-
-Rotate API Key
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | API key ID, prefixed `apik_`. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop api-keys update
-
-Update API Key
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | API key ID, prefixed `apik_`. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--api_version_date` | `string` | no |  | Dated API version used when requests authenticated with this key omit the `Api-Version-Date` header. New keys default to the latest version. |
-| `--expires_at` | `unknown` | no |  | When the API key should stop working, as an ISO 8601 timestamp. Omit (or pass `null` on update) for a key that never expires. |
-| `--ip_allowlist` | `unknown` | no |  | IPv4/IPv6 CIDR ranges allowed to use this key, for example `["203.0.113.0/24"]`. Empty or `null` allows any IP. |
-| `--name` | `unknown` | no |  | A new human-readable name for the API key. |
-| `--permissions` | `object` | no |  | The permissions policy for the API key: explicit permission statements, or a system role to inherit from. Statements without a `resources` array default to the owning account (Account API keys) or every key-addressable resource (App API keys). |
-
-> Confirm with the user before executing this destructive command.

package/skills/whop-app-builds/SKILL.md

@@ -1,81 +0,0 @@
----
-name: whop-app-builds
-description: Versioned build artifacts deployed to an app's platforms. Run `whop app-builds --help` for usage details.
-requires_bin: whop
-command: whop app-builds
----
-
-An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build.
-
-Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production.
-
-# whop app-builds create
-
-Create App Build
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--ai_prompt_id` | `string` | no |  | The AI prompt that generated this build, if applicable. |
-| `--app_id` | `string` | no |  | The app to create the build for, prefixed `app_`. Defaults to the app behind the presented credential. |
-| `--attachment` | `object` | yes |  | The uploaded build file: `{ id }` for an existing file or `{ direct_upload_id }` for a completed direct upload. |
-| `--checksum` | `string` | yes |  | A client-generated checksum of the build file, used to verify file integrity when unpacked. |
-| `--platform` | `string` | yes |  | The target platform for the build. |
-| `--source_attachment` | `object` | no |  | An optional compressed archive (.zip or .gz) of the source code that produced this build, stored alongside the build so it can be downloaded later. Referenced like `attachment`, and must be a different file. |
-| `--supported_app_view_types` | `array` | no |  | The view types this build supports. Only list the ones its code implements. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop app-builds get
-
-Retrieve App Build
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | App build ID, prefixed `abld_`. |
-
----
-
-# whop app-builds list
-
-List App Builds
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--app_id` | `string` | yes |  | The app to list builds for, prefixed `app_`. |
-| `--platform` | `string` | no |  | Filter builds by target platform. |
-| `--status` | `string` | no |  | Filter builds by review status. |
-| `--created_before` | `number` | no |  | Only return builds created before this ISO 8601 timestamp. |
-| `--created_after` | `number` | no |  | Only return builds created after this ISO 8601 timestamp. |
-| `--first` | `number` | no |  | The number of builds to return (default 20, max 100). |
-| `--after` | `string` | no |  | A cursor; returns builds after this position. |
-| `--last` | `number` | no |  | The number of builds to return from the end of the range. |
-| `--before` | `string` | no |  | A cursor; returns builds before this position. |
-
----
-
-# whop app-builds promote
-
-Promote App Build
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | App build ID, prefixed `abld_`. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.

package/skills/whop-apps/SKILL.md

@@ -1,161 +0,0 @@
----
-name: whop-apps
-description: "Apps you build on Whop: metadata, hosted builds, runtime logs. Run `whop apps --help` for usage details."
-requires_bin: whop
-command: whop apps
----
-
-An App is software you build on Whop. It can be a hosted web app served at `<route>.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs.
-
-Use the Apps API to manage app configuration and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text.
-
-# whop apps create
-
-Create App
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | The account to create the app for (`biz_` tag). Defaults to the account behind the presented credential. |
-| `--app_type` | `string` | no |  | The type of app to create. Defaults to `b2c_app`. |
-| `--base_url` | `unknown` | no |  | The base production URL where the app is hosted, such as `https://myapp.example.com`. |
-| `--icon` | `object` | no |  | The icon image for the app in PNG, JPEG, or GIF format, referencing an uploaded file: `{ id }` for an existing attachment or `{ direct_upload_id }` for a new direct upload. |
-| `--name` | `string` | yes |  | The display name for the app, shown to users on the app store and product pages. |
-| `--redirect_uris` | `array` | no |  | The whitelisted OAuth callback URLs that users are redirected to after authorizing the app. |
-| `--route` | `unknown` | no |  | The subdomain route where the app's hosted web builds are served, such as `myapp` for myapp.whop.app. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop apps delete
-
-Delete App
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | App ID (prefixed `app_`), the app's claimed route, or its proxy domain id. |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop apps get
-
-Retrieve App
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | App ID (prefixed `app_`), the app's claimed route, or its proxy domain id. |
-
----
-
-# whop apps list
-
-List Apps
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | Only return apps created by this account (`biz_` tag). With developer access to the account this includes its unlisted and hidden apps. |
-| `--app_type` | `string` | no |  | Filter apps by the type of end-user they are built for. Apps of type `website` are left out unless you ask for them by name. |
-| `--view_type` | `string` | no |  | Only return apps supporting this view type, such as `dashboard` or `hub`. |
-| `--verified_apps_only` | `boolean` | no |  | Whether to only return apps verified by Whop. Verified website templates — websites with a published web build — are included, even though websites are otherwise left out of app lists. |
-| `--query` | `string` | no |  | A search string matched against app names. |
-| `--order` | `string` | no |  | The field to sort apps by. Defaults to discoverable_at, showing the most recently published apps first. |
-| `--direction` | `string` | no |  | Sort direction. |
-| `--first` | `number` | no |  | The number of apps to return (default 20, max 100). |
-| `--after` | `string` | no |  | A cursor; returns apps after this position. |
-| `--last` | `number` | no |  | The number of apps to return from the end of the range. |
-| `--before` | `string` | no |  | A cursor; returns apps before this position. |
-
----
-
-# whop apps logs
-
-List App Logs
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ID of the app, which will look like app_*************. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--app_build_id` | `string` | no |  | Only return logs from this build. |
-| `--level` | `string` | no |  | Only return console lines of this level. |
-| `--query` | `string` | no |  | Only return logs whose message contains this text (case-insensitive). |
-| `--created_after` | `string` | no |  | Start of the time window as an ISO 8601 timestamp. Defaults to 7 days before created_before. |
-| `--created_before` | `string` | no |  | End of the time window as an ISO 8601 timestamp. Defaults to now. |
-| `--first` | `number` | no |  | The number of log lines to return (max 500). |
-| `--after` | `string` | no |  | A cursor for fetching logs after a previous page. |
-| `--before` | `string` | no |  | A cursor for fetching logs before a later page. |
-
----
-
-# whop apps permissions
-
-Update App Permissions
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | App ID, prefixed `app_`. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--requested_permissions` | `array` | yes |  | The full set of permissions the app requests on install; permissions not listed are removed. |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop apps update
-
-Update App
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | App ID (prefixed `app_`), the app's claimed route, or its proxy domain id. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--app_store_description` | `string` | no |  | The detailed description shown on the app store's in-depth app view page. |
-| `--app_type` | `string` | no |  | The type of end-user the app is built for. Cannot be changed on an app whose type is already `website`. |
-| `--base_url` | `unknown` | no |  | The base production URL where the app is hosted. Set to `null` to take the app proxy offline. |
-| `--dashboard_path` | `unknown` | no |  | The URL path for the account dashboard view. |
-| `--description` | `string` | no |  | A short description of the app shown in listings and search results. |
-| `--discover_path` | `unknown` | no |  | The URL path for the discover view. |
-| `--experience_path` | `unknown` | no |  | The URL path for the member-facing hub view, such as `/experiences/[experienceId]`. |
-| `--icon` | `object` | no |  | The icon image for the app in PNG, JPEG, or GIF format, referencing an uploaded file: `{ id }` for an existing attachment or `{ direct_upload_id }` for a new direct upload. |
-| `--name` | `string` | no |  | The display name for the app, shown to users on the app store and product pages. |
-| `--oauth_client_type` | `string` | no |  | How the app authenticates at the OAuth token endpoint. |
-| `--openapi_path` | `unknown` | no |  | The URL path to the app's OpenAPI spec file (requires the ai_chat capability). |
-| `--production_android_build_id` | `unknown` | no |  | The app build (`abld_` tag) to serve as the Android production build, or `null` to unassign it. Same rules as `production_web_build_id`. |
-| `--production_ios_build_id` | `unknown` | no |  | The app build (`abld_` tag) to serve as the iOS production build, or `null` to unassign it. Same rules as `production_web_build_id`. |
-| `--production_web_build_id` | `unknown` | no |  | The app build (`abld_` tag) to serve as the web production build, or `null` to unassign it. The build must belong to this app, target web, and be in the draft or approved status; a draft build is queued for approval and takes over once approved. Requires the `developer:manage_builds` scope. |
-| `--redirect_uris` | `array` | no |  | The whitelisted OAuth callback URLs users are redirected to after authorizing the app. |
-| `--required_scopes` | `array` | no |  | The OAuth scopes the app requests from users when they install it. |
-| `--route` | `string` | no |  | The subdomain route where the app's hosted web builds are served. |
-| `--secrets` | `object` | no |  | Secrets to add or overwrite on the app, as an object of string values. Keys not included are left untouched; pass null or an empty string as the value to delete a secret. Encrypted at rest and injected into the app's hosted server runtime. |
-| `--skills_path` | `unknown` | no |  | The URL path to the app's skills directory (requires the ai_chat capability). |
-| `--status` | `string` | no |  | Controls whether the app is published on Whop discovery or accessible only through its direct link. Publishing requires a name, icon, and description. |
-
-> Confirm with the user before executing this destructive command.