doctor diagnoses your setup and surfaces misconfigurations, while
checklist shows the live, per-app status of what's required to go live.
Commands
Every CashSDK CLI command with a description and example.
Run any command as cashsdk <command> (global install) or
npx @cashsdk/cli <command>. All commands read CASHSDK_TOKEN and
CASHSDK_API_URL from your environment or from cashsdk login. Add --help
to any command for its full options.
Reference#
| Command | Description |
|---|---|
login | Authenticate the CLI and store credentials locally. |
apps | List the apps in your workspace. |
catalog | View and manage products, entitlements, and offerings. |
checklist | Show the live go-live setup status for an app. |
doctor | Diagnose your setup and report configuration problems. |
draft | Scaffold a paywall draft you can refine and publish. |
events | Stream and inspect recent events. |
paywalls | List and inspect paywalls. |
snippets | Print ready-to-paste SDK integration snippets. |
templates | Browse available paywall templates. |
Examples#
bash
cashsdk login
# Or skip the prompt with environment variables:
CASHSDK_TOKEN=csk_sk_... CASHSDK_API_URL=https://api.cashsdk.com cashsdk apps
bash
cashsdk apps
bash
# List the current catalog
cashsdk catalog
# Add a monthly subscription with an entitlement
cashsdk catalog add \
--product pro_monthly \
--entitlement pro \
--type subscription
bash
cashsdk checklist --app app_...
bash
cashsdk doctor --app app_...
bash
cashsdk draft --template trial --name onboarding
bash
# Tail recent events for an app
cashsdk events --app app_... --tail
bash
cashsdk paywalls --app app_...
bash
# Print iOS integration snippets
cashsdk snippets --platform ios --app app_...
bash
cashsdk templates
Flags such as --app are shown for clarity — when you set CASHSDK_APP (or
have a single app), the CLI uses it by default. Run cashsdk <command> --help
for the exact options.