Terminal
Terminal/Skill
Gives a coding agent Superwall SDK integration, review, migration, and App Store subscription and account setup via the CLI.
By Superwall
Works with
npx skills add superwall/skills --skill superwallUse this skill in a local coding environment. Read the relevant reference
before proceeding. Code integration and review can start from repository files
and current documentation; account commands need the superwall CLI. When the
Superwall MCP connector is available, use its tools directly for account data
and configuration. Use the CLI for capabilities the connector does not expose.
CLI tasks require a one-time user installation:
npm install --global superwall
Use superwall ... directly once it is installed. Do not automatically install
or upgrade the CLI, or use a download-and-run fallback. Ask the user to install
it if a requested CLI task cannot proceed. Bundled playbooks, references, local
SDK review, and documentation tasks remain available without the CLI.
Before running account CLI commands, check whether the superwall CLI is on
PATH and authenticated. SDK code and documentation work can proceed without
this step. Probe once; the output tells you what to do:
superwall whoami --json
superwall: command not found → ask the user to complete the prerequisite.
Continue tasks that can use bundled files and documentation without the CLI.{"authenticated": false} → ask the user to run superwall login (device
-flow OAuth; it opens a browser, so you can't do it for them). For CI/headless
use, have the user configure authentication privately using superwall login --help.The session lives under ~/.superwall; account commands act as the logged-in
user. A plugin installation already includes these skills, so use its bundled
files rather than assuming a separate standalone skill installation is needed.
Act only on the user's requested task. Confirm the active organization and explicit project/application IDs before account operations. Listing examples are documentation, not permission to execute writes.
Use when: managing resources, scoping to a project/app, calling /v2/..., or
viewing the account with bootstrap.
Read the CLI reference.
superwall apps list --json
superwall products list --project <id> --json
superwall campaigns create "New user paywall" onboarding_complete --project <id> --app <id> --json
Use when: creating or managing anything in App Store Connect - subscriptions,
IAPs, prices, introductory/promotional offers, groups. superwall asc proxies
the entire ASC API with a signed request (no .p8/JWT).
Before any asc post/asc patch, run superwall asc docs <path> <verb> for
the exact schema. Pass flat -d params - the proxy builds the JSON:API body and
validates it, returning the precise fix if it's wrong. Never guess a body.
Read the App Store Connect reference.
superwall asc docs "subscription" # discover endpoints
superwall asc docs /v1/subscriptions post # exact schema
superwall asc post /v1/subscriptions -d name="Pro Monthly" \
-d productId=com.acme.pro -d subscriptionPeriod=ONE_MONTH -d group=<id> --json
Use when: reading or managing Apple Search Ads - campaigns, ad groups,
keywords, negative keywords, ads, creatives, reports, budget orders.
superwall asa proxies the entire Apple Ads Campaign Management API v5 with the
credentials connected in the dashboard (no client secret, token, or org id).
Before any asa <resource> create|update, run superwall asa docs <resource> <action>
for Apple's exact fields and enums. Typed flags cover the common fields; --body
sends a full payload. Never guess a body.
Read the Apple Search Ads reference.
superwall asa docs # every endpoint, grouped
superwall asa docs campaigns create # Apple's page: fields, enums, examples
superwall asa campaigns find --field status --op EQUALS --values ENABLED --all --json
superwall asa keywords create --campaign <id> --adgroup <id> \
--text "grammar checker" --match-type EXACT --bid 1.25 --json
Use when: querying events/revenue/subscriptions or building custom dashboards and recurring report/notification workflows.
Read the data analytics reference.
Use this when the user's task calls for Superwall account data or analytics and the connector does not expose the needed capability.
superwall query "SELECT ..." --json
superwall query --file report.sql --json
Use when: looking up docs, integrating/debugging an SDK, linking dashboard pages, cloning SDK source, or configuring webhooks.
Read the documentation reference.
curl -sL https://superwall.com/docs/llms.txt # Find the right page
curl -sL https://superwall.com/docs/{path}.md # Fetch a specific page
Use when: integrating, migrating, reviewing an existing setup, adding placements, or wiring campaigns.
Use the installed CLI with --skill to print workflow instructions, then
perform the work yourself. Running integration, review, or migration without
--skill spawns another agent. When the CLI is unavailable, read the bundled
workflows/<job>/playbook.md and the relevant framework or provider file.
Use those bundled files as well if the installed CLI does not support --skill;
do not automatically upgrade it.
| Job | Bundled instructions | Print instructions with the installed CLI |
|---|---|---|
| Full setup | workflows/integrate/playbook.md + the <framework>.md beside it (ios, android, expo, react-native, flutter), then workflows/placements/ and workflows/dashboard/ | superwall integrate --skill |
| Placements at feature gates | workflows/placements/playbook.md + strategy.md + the <framework>.md beside it | included in superwall integrate --skill |
| Entitlements, products, campaigns | workflows/dashboard/playbook.md + setup.md | included in superwall integrate --skill |
| Existing setup review | workflows/review/playbook.md + the <framework>.md beside it (not references/, which is the CLI and API) | superwall review --skill |
| Provider migration | workflows/migrate/playbook.md + revenuecat.md / adapty.md / qonversion.md beside it | superwall migrate --skill |
The CLI can print a workflow with superwall <job> --skill; the bundled
playbooks remain available here when the CLI is unavailable.
When the user asks you to send feedback about the CLI or a Superwall workflow,
summarize the issue and send it upstream with superwall feedback. Do not send
feedback to the team based only on a complaint in conversation.
superwall feedback "user hit X running Y; expected Z" --json