@whop/cli 0.14.1 → 0.14.3

package/skills/whop-users/SKILL.md

@@ -9,21 +9,298 @@ A User represents a person on Whop. Users have a public profile and can buy prod
 
 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.
 
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `whop users list` | List Users |
-| `whop users me` | Retrieve Current User |
-| `whop users update-me` | Update Current User |
-| `whop users preferences` | Retrieve |
-| `whop users update-preferences` | Update |
-| `whop users set-notification-preferences` | Set |
-| `whop users experience-notification-preferences` | List Experiences |
-| `whop users notification-topic-preferences` | List Topics |
-| `whop users get` | Retrieve User |
-| `whop users update` | Update User |
-| `whop users access` | Check User Access |
-| `whop users recommend_actions` | List Recommended Actions |
-
-Run `whop users <command> --help` for options, or `whop users <command> --schema` for full argument details.
+# whop users access
+
+Check User Access
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The user_ tag or username to check access for. |
+| `resource_id` | `string` | yes | An account (biz_), product (prod_), or experience (exp_) ID. |
+
+---
+
+# whop users authorize-app
+
+Authorize an App
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Authorize the app for one of the user's accounts rather than for the user alone, prefixed `biz_`. The user must have access to it. |
+| `--client_id` | `string` | yes |  | The app being authorized, prefixed `app_`. |
+| `--code_challenge` | `string` | yes |  | The PKCE code challenge: the base64url-encoded SHA-256 of your code verifier, without padding. |
+| `--code_challenge_method` | `string` | yes |  | How `code_challenge` was derived. Only `S256` is accepted. |
+| `--consent_shown` | `boolean` | no | `true` | Whether the consent UI listed these scopes for the user. Sending `false` succeeds only when the user has already granted every scope requested. |
+| `--nonce` | `string` | no |  | OIDC nonce, echoed into the resulting ID token. Required when `requested_scopes` includes `openid`. |
+| `--redirect_uri` | `string` | yes |  | Where to send the user once they have consented. Must match one of the app's registered redirect URIs exactly — it is compared as a string, not normalized. |
+| `--requested_scopes` | `array` | yes |  | The permissions the app is asking for, for example `member:basic:read`. `GET /api_keys/permissions` names and describes each one. Granting adds to whatever the user already granted this app rather than replacing it. |
+| `--response_type` | `string` | no |  | The OAuth response type. Only `code` is accepted; defaults to `code`. |
+| `--state` | `string` | no |  | Opaque value appended to `redirect_url` unchanged, for the client to correlate the response with its request. |
+| `--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 users delete-passkey
+
+Delete
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Passkey ID, prefixed `wcred_`. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--authenticator_data` | `string` | yes |  | The `authenticatorData` from the WebAuthn assertion, base64url-encoded. |
+| `--client_data_json` | `string` | yes |  | The `clientDataJSON` from the WebAuthn assertion, base64url-encoded. |
+| `--signature` | `string` | yes |  | The `signature` from the WebAuthn assertion, base64url-encoded. |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop users experience-notification-preferences
+
+List Experiences
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--first` | `number` | no |  | The number of preferences to return. |
+| `--after` | `string` | no |  | A cursor; returns preferences after this position. |
+
+---
+
+# whop users get
+
+Retrieve User
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | User ID (prefixed `user_`) or username. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | When set, returns the user's account-specific profile overrides for this account. |
+
+---
+
+# whop users list
+
+List Users
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--query` | `string` | no |  | A search term to filter users by name or username. |
+| `--first` | `number` | no |  | The number of users to return (max 50). |
+| `--after` | `string` | no |  | A cursor; returns users after this position. |
+| `--last` | `number` | no |  | The number of users to return from the end of the range. |
+| `--before` | `string` | no |  | A cursor; returns users before this position. |
+
+---
+
+# whop users me
+
+Retrieve Current User
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | When set, returns your account-specific profile overrides for this account. |
+| `--include_balance_history` | `boolean` | no |  | Also compute your balance history (opt-in; runs a heavier query). Ignored for callers without balance-read scope. |
+| `--from` | `string` | no |  | Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with `include_balance_history`. |
+| `--to` | `string` | no |  | Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with `include_balance_history`. |
+| `--interval` | `string` | no |  | Balance-history point granularity. Defaults to `day`. Only used with `include_balance_history`. |
+| `--time_zone` | `string` | no |  | IANA time zone the balance-history points are bucketed in. Defaults to `UTC`. Only used with `include_balance_history`. |
+
+---
+
+# whop users me-oauth_grants
+
+List OAuth Grants
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--app_id` | `string` | no |  | Only return grants for this app, prefixed `app_`. An app the user has never authorized returns an empty list. |
+| `--first` | `number` | no |  | The number of grants to return (default 20, max 100). |
+| `--after` | `string` | no |  | A cursor; returns grants after this position. |
+| `--last` | `number` | no |  | The number of grants to return from the end of the range. |
+| `--before` | `string` | no |  | A cursor; returns grants before this position. |
+| `--order` | `string` | no |  | The field to sort grants by. |
+| `--direction` | `string` | no |  | Sort direction. |
+
+---
+
+# whop users notification-topic-preferences
+
+List Topics
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--channel` | `string` | no |  | Only return preferences for this delivery channel (or not narrowed to a channel). |
+| `--account_id` | `string` | no |  | Only return preferences scoped to this account's member notifications (`biz_` tag). |
+| `--team_account_id` | `string` | no |  | Only return preferences scoped to this account's team notifications (`biz_` tag). |
+| `--experience_id` | `string` | no |  | Only return preferences scoped to this experience (`exp_` tag). |
+| `--topic_id` | `string` | no |  | Only return preferences scoped to this notification topic (`topic_` tag). |
+| `--first` | `number` | no |  | The number of preferences to return. |
+| `--after` | `string` | no |  | A cursor; returns preferences after this position. |
+
+---
+
+# whop users passkey-challenge
+
+Create Challenge
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--challenge_type` | `string` | yes |  | The ceremony this challenge is for. |
+| `--passkey_id` | `string` | no |  | The passkey the ceremony targets, prefixed `wcred_`. Required when `challenge_type` is `deletion`, ignored otherwise. |
+| `--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 users passkeys
+
+List
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--first` | `number` | no |  | The number of passkeys to return (default 20, max 100). |
+| `--after` | `string` | no |  | A cursor; returns passkeys after this position. |
+| `--last` | `number` | no |  | The number of passkeys to return from the end of the range. |
+| `--before` | `string` | no |  | A cursor; returns passkeys before this position. |
+| `--order` | `string` | no |  | The field to sort passkeys by. |
+| `--direction` | `string` | no |  | Sort direction. |
+
+---
+
+# whop users preferences
+
+Retrieve
+
+---
+
+# whop users recommend_actions
+
+List Recommended Actions
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | `me`, or the authenticated user's own `user_` tag or username. |
+
+---
+
+# whop users register-passkey
+
+Register
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--attestation_object` | `string` | yes |  | The `attestationObject` from the WebAuthn attestation response, base64url-encoded. |
+| `--client_data_json` | `string` | yes |  | The `clientDataJSON` from the WebAuthn attestation response, base64url-encoded. |
+| `--credential_id` | `string` | yes |  | The WebAuthn credential ID the authenticator returned, base64url-encoded. |
+| `--nickname` | `string` | yes |  | A name for this passkey, usually the device it lives on. 255 characters or fewer. |
+| `--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 users set-notification-preferences
+
+Set
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--preferences` | `array` | yes |  | The preferences to set, at most 100 per request. |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop users update
+
+Update User
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | User ID (prefixed `user_`) or username. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The account whose profile override to update. Required for API key callers. |
+| `--bio` | `string` | no |  |  |
+| `--name` | `string` | no |  |  |
+| `--profile_picture` | `object` | no |  |  |
+| `--username` | `string` | no |  |  |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop users update-me
+
+Update Current User
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | When set, updates the authenticated user's profile override for this account instead of their global profile. |
+| `--bio` | `string` | no |  |  |
+| `--name` | `string` | no |  |  |
+| `--profile_picture` | `object` | no |  |  |
+| `--username` | `string` | no |  |  |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop users update-preferences
+
+Update
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--investigation_enabled` | `boolean` | no |  | Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access. |
+
+> Confirm with the user before executing this destructive command.

package/skills/whop-verifications/SKILL.md

@@ -9,17 +9,59 @@ A Verification represents a legal identity for a person or business. Accounts an
 
 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).
 
-## Commands
+# whop verifications create
 
-| Command | Description |
-|---------|-------------|
-| `whop verifications list` | List Verifications |
-| `whop verifications create` | Create Verification |
-| `whop verifications get` | Retrieve Verification |
-| `whop verifications update` | Update Verification |
+Create Verification
 
-Run `whop verifications <command> --help` for options, or `whop verifications <command> --schema` for full argument details.
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account or user ID whose identity you want to verify. Use a `biz_` account ID for account verifications, or the caller's `user_` ID for personal verification. |
+| `--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 verifications get
+
+Retrieve Verification
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `verification_id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
+
+---
+
+# whop verifications list
+
+List Verifications
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account or user ID whose verifications you want to list. Use a `biz_` account ID, or the caller's `user_` ID for personal verifications. |
+| `--order` | `string` | no |  | Field used to sort returned verifications. |
+| `--direction` | `string` | no |  | Sort direction for returned verifications. |
+
+---
+
+# whop verifications update
+
+Update Verification
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `verification_id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
+
+> Confirm with the user before executing this destructive command.
 
 ## Steps that finish in the browser
 
-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.
+Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`, `checkout_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.