@superwall/cli 1.4.0 → 1.6.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/README.md +21 -5
- package/dist/{actions-EfP8phmb.js → actions-Dt35nIi8.js} +3 -2
- package/dist/{api-CEwXCCoC.js → api-BOR-uXZe.js} +9 -9
- package/dist/{app-D8mEVlQo.js → app-BU27SLPX.js} +9 -9
- package/dist/{asa-BFWehnTA.js → asa-2ykGnjaV.js} +11 -11
- package/dist/{asc-DJqQmtmR.js → asc-r3xmFT0L.js} +14 -14
- package/dist/{auth-CT2DWX8r.js → auth-BWZfguI8.js} +9 -9
- package/dist/auth.js +2 -2
- package/dist/{billing-BzEnVPD2.js → billing-BsQgXXYh.js} +1 -1
- package/dist/{bind-BZxVyt9P.js → bind-BSTAinn6.js} +5 -4
- package/dist/{command-DP96_gmP.js → command-DMoMn7uc.js} +39 -16
- package/dist/{create-Q8TqqjZt.js → create-CSo6XjSm.js} +118 -91
- package/dist/dev-B0MF6z3L.js +21 -0
- package/dist/{dev-DlCcwFu5.js → dev-CuXa3J4Z.js} +29 -24
- package/dist/{doctor-CJsjHpCZ.js → doctor-DXJaDqsx.js} +10 -10
- package/dist/{drivers-UT36AnOw.js → drivers-Cr252DOJ.js} +3 -3
- package/dist/entry.js +84 -50
- package/dist/{existing-Cak1WxWB.js → existing-Ckx_g7Be.js} +6 -3
- package/dist/{feedback-DDRzoqPx.js → feedback-Dt5yebMS.js} +6 -6
- package/dist/{hosted-CEH78QVn.js → hosted-Cjekn8oJ.js} +2 -2
- package/dist/{integrate-D8jyhDzk.js → integrate-DVqhvPVq.js} +25 -66
- package/dist/{login-kneYhhk0.js → login-Bjj8QvIN.js} +6 -6
- package/dist/migrate-qmvOtp3l.js +283 -0
- package/dist/open-studio-CpHqjovS.js +1299 -0
- package/dist/{org-Cg25bcsj.js → org-CV8c849b.js} +3 -3
- package/dist/{output-csAtR6kJ.js → output-CiELrN8w.js} +15 -2
- package/dist/{pipeline-DAeI9tHs.js → pipeline-DSCHL9KA.js} +482 -9
- package/dist/{print-skill-BHVPP9cX.js → print-skill-CaHRJ8xW.js} +7 -7
- package/dist/{promote-Boek5K2d.js → promote-UMTh8Q33.js} +17 -18
- package/dist/publish-DWX8S9yZ.js +34 -0
- package/dist/push-Dox4_5Dq.js +34 -0
- package/dist/{query-B8G6T8Ba.js → query-CnSsDZ7Q.js} +10 -10
- package/dist/reports-C0xHCLnt.js +27 -0
- package/dist/{resource-DjsWVka-.js → resource-5bgyyL9B.js} +15 -15
- package/dist/{resources-s64mBHaC.js → resources-Bf9O1JNM.js} +28 -2
- package/dist/{run-BtcQJCP8.js → run-BVeZWbXx.js} +39 -22
- package/dist/{scan-DJixvuHn.js → scan-CAObNRgc.js} +44 -4
- package/dist/skills/superwall/SKILL.md +146 -0
- package/dist/skills/superwall/references/api.md +275 -0
- package/dist/skills/superwall/references/asa.md +160 -0
- package/dist/skills/superwall/references/asc.md +96 -0
- package/dist/skills/superwall/references/dashboard-links.md +57 -0
- package/dist/skills/superwall/references/data-analytics.md +893 -0
- package/dist/skills/superwall/references/docs.md +51 -0
- package/dist/skills/superwall/references/sdk-integration.md +105 -0
- package/dist/skills/superwall/references/sdk-source.md +18 -0
- package/{skills/superwall-dashboard/SKILL.md → dist/skills/superwall/workflows/dashboard/playbook.md} +3 -9
- package/{skills/superwall-dashboard/references → dist/skills/superwall/workflows/dashboard}/setup.md +1 -3
- package/dist/skills/superwall/workflows/integrate/android.md +292 -0
- package/{skills/superwall-integrate/SKILL.md → dist/skills/superwall/workflows/integrate/playbook.md} +16 -11
- package/{skills/superwall-migrate/references → dist/skills/superwall/workflows/migrate}/adapty.md +4 -4
- package/{skills/superwall-migrate/SKILL.md → dist/skills/superwall/workflows/migrate/playbook.md} +4 -10
- package/{skills/superwall-migrate/references → dist/skills/superwall/workflows/migrate}/qonversion.md +4 -4
- package/{skills/superwall-migrate/references → dist/skills/superwall/workflows/migrate}/revenuecat.md +4 -4
- package/dist/skills/superwall/workflows/placements/android.md +175 -0
- package/{skills/superwall-placements/references → dist/skills/superwall/workflows/placements}/expo.md +1 -1
- package/{skills/superwall-placements/references → dist/skills/superwall/workflows/placements}/flutter.md +1 -1
- package/{skills/superwall-placements/references → dist/skills/superwall/workflows/placements}/ios.md +1 -1
- package/{skills/superwall-placements/SKILL.md → dist/skills/superwall/workflows/placements/playbook.md} +6 -10
- package/{skills/superwall-placements/references → dist/skills/superwall/workflows/placements}/react-native.md +2 -2
- package/{skills/superwall-placements/references → dist/skills/superwall/workflows/placements}/strategy.md +4 -3
- package/dist/skills/superwall/workflows/review/android.md +120 -0
- package/{skills/superwall-review/references → dist/skills/superwall/workflows/review}/expo.md +1 -1
- package/{skills/superwall-review/references → dist/skills/superwall/workflows/review}/flutter.md +1 -1
- package/{skills/superwall-review/references → dist/skills/superwall/workflows/review}/ios.md +1 -1
- package/{skills/superwall-review/SKILL.md → dist/skills/superwall/workflows/review/playbook.md} +2 -7
- package/{skills/superwall-review/references → dist/skills/superwall/workflows/review}/react-native.md +1 -1
- package/dist/skills/superwall-framework/SKILL.md +253 -0
- package/dist/skills/superwall-framework/references/cli.md +340 -0
- package/dist/skills/superwall-framework/references/examples.md +123 -0
- package/dist/skills/superwall-framework/references/layout.md +295 -0
- package/dist/skills/superwall-framework/references/migrate-from-editor.md +208 -0
- package/dist/skills/superwall-framework/references/migrate-from-native.md +193 -0
- package/dist/skills/superwall-framework/references/mobile-design.md +371 -0
- package/dist/skills/superwall-framework/references/native/android.md +83 -0
- package/dist/skills/superwall-framework/references/native/flutter.md +65 -0
- package/dist/skills/superwall-framework/references/native/ios.md +77 -0
- package/dist/skills/superwall-framework/references/native/react-native.md +67 -0
- package/dist/skills/superwall-framework/references/responsive.md +162 -0
- package/dist/{skills-CRG1xk0G.js → skills-Cu41i-Az.js} +12 -12
- package/dist/{skills-CODut1Hn.js → skills-grTDuHlc.js} +134 -36
- package/dist/{spinner-B9dT3DBY.js → spinner-DFctF_Jw.js} +1 -1
- package/dist/{telemetry-BtkMdT-5.js → telemetry-BuCbmoux.js} +3 -3
- package/dist/{token-hM7V1KMG.js → token-mju3Q-vc.js} +3 -3
- package/dist/{ui-Lqt_zFOr.js → ui-4gLyfrgl.js} +76 -46
- package/dist/{update-CeylIjx5.js → update-DnGfpCD7.js} +2 -2
- package/dist/{upgrade-DRqUfCBT.js → upgrade-PMoj3yqJ.js} +6 -6
- package/package.json +8 -7
- package/prompts/actions/paywall-migrate.xml +24 -0
- package/prompts/actions/screen-migrate.xml +26 -0
- package/dist/git-ZwA3Mx8m.js +0 -433
- package/dist/migrate-D_x1oyTk.js +0 -114
- package/dist/publish-C-zEUnO9.js +0 -35
- package/dist/push-DUDQG-EO.js +0 -35
- package/skills/README.md +0 -118
- /package/dist/{api-output-D9ggXQIr.js → api-output-CEhN-U_N.js} +0 -0
- /package/dist/{asc-products-C6MvSy8H.js → asc-products-1e1DoGeL.js} +0 -0
- /package/dist/{params-B1zeElGa.js → params-BxgTuCzr.js} +0 -0
- /package/{skills/superwall-integrate/references → dist/skills/superwall/workflows/integrate}/expo.md +0 -0
- /package/{skills/superwall-integrate/references → dist/skills/superwall/workflows/integrate}/flutter.md +0 -0
- /package/{skills/superwall-integrate/references → dist/skills/superwall/workflows/integrate}/ios.md +0 -0
- /package/{skills/superwall-integrate/references → dist/skills/superwall/workflows/integrate}/react-native.md +0 -0
- /package/dist/{storekit-DPonXSwe.js → storekit-Dlpbq5Wv.js} +0 -0
package/skills/README.md
DELETED
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
# Skills
|
|
2
|
-
|
|
3
|
-
The agent skills that ship inside `@superwall/cli`. Each is a self-contained
|
|
4
|
-
playbook — a lean `SKILL.md` router plus deep `references/` — that the CLI
|
|
5
|
-
composes for the user's platform and hands to their coding agent (Claude Code
|
|
6
|
-
or Codex). They follow the [agent skills](https://agentskills.io) format, so
|
|
7
|
-
they also install directly into any agent with `npx skills add`.
|
|
8
|
-
|
|
9
|
-
| Skill | What it does | References | Driven by |
|
|
10
|
-
| -------------------------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------ |
|
|
11
|
-
| [`superwall-integrate`](superwall-integrate) | Install and configure the SDK in an app for the first time | `ios` `expo` `react-native` `flutter` | `superwall integrate` |
|
|
12
|
-
| [`superwall-placements`](superwall-placements) | Add or audit placements at feature gates and route them to campaigns | `strategy` + one framework | `superwall integrate` (phase 2) |
|
|
13
|
-
| [`superwall-dashboard`](superwall-dashboard) | Create the entitlements, products, and campaigns a placement needs to present | `setup` | `superwall integrate` (phase 3) |
|
|
14
|
-
| [`superwall-review`](superwall-review) | Audit an existing setup end to end; `--fix` repairs verified findings | `ios` `expo` `react-native` `flutter` | `superwall review [--fix]` |
|
|
15
|
-
| [`superwall-migrate`](superwall-migrate) | Move an app off RevenueCat, Adapty, or Qonversion | `revenuecat` `adapty` `qonversion` | `superwall migrate` |
|
|
16
|
-
|
|
17
|
-
The broad toolkit skills — `superwall` (resources, analytics SQL, docs, SDK
|
|
18
|
-
triage) and `superwall-editor` (build paywalls in the visual editor from the
|
|
19
|
-
CLI) — live in the public [superwall/skills](https://github.com/superwall/skills)
|
|
20
|
-
repo. `superwall login` installs them into your agent and `superwall skills`
|
|
21
|
-
keeps them updated. Building paywalls and funnels as code is the framework's
|
|
22
|
-
job: see the [root README](../../../README.md) and `superwall create`.
|
|
23
|
-
|
|
24
|
-
## How a skill reaches the agent
|
|
25
|
-
|
|
26
|
-
- **Composed at run time.** `loadBundledSkill(id, reference)` in
|
|
27
|
-
`src/core/agent/skills.ts` joins `SKILL.md` with exactly the references the
|
|
28
|
-
detected app needs (`FRAMEWORK_REF` in `src/core/agent/actions.ts`;
|
|
29
|
-
placements always adds `strategy`). An Expo agent never sees Swift docs.
|
|
30
|
-
Frontmatter is stripped; a missing reference file is a hard error.
|
|
31
|
-
- **Wrapped by the harness.** `prompts/actions/<action>.xml` adds the task
|
|
32
|
-
framing and `[STATUS]` protocol; `prompts/commandments.xml` the guardrails.
|
|
33
|
-
Harness protocol lives there, never in a skill.
|
|
34
|
-
- **Or printed.** `superwall integrate|migrate|review --skill` writes the
|
|
35
|
-
composed playbook to stdout for an agent you drive yourself. `integrate
|
|
36
|
-
--skill` is all three phases (integrate → placements → dashboard) in order.
|
|
37
|
-
- **Or installed.** `superwall skills` delegates to the `skills` CLI
|
|
38
|
-
(`npx -y skills@latest add …`), which owns locations and agent detection.
|
|
39
|
-
|
|
40
|
-
## Layout
|
|
41
|
-
|
|
42
|
-
```
|
|
43
|
-
skills/superwall-<task>/
|
|
44
|
-
SKILL.md router, ≤ ~80 lines: when to use, principles, the
|
|
45
|
-
flow, a table routing to references, the CLI commands
|
|
46
|
-
the agent will need, a Docs access block
|
|
47
|
-
references/<x>.md the depth — one file per framework or provider
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
- Reference file names are the contract: they match `Integration` values
|
|
51
|
-
(`ios` for swift, `expo`, `react-native`, `flutter`) or provider slugs.
|
|
52
|
-
- `SKILL.md` frontmatter is `name` (equal to the directory) and `description`
|
|
53
|
-
written as when-to-use: what the skill does, the situations that activate
|
|
54
|
-
it, and what it is **not** for (pointing at the sibling skill).
|
|
55
|
-
|
|
56
|
-
### Reference file anatomy, in order
|
|
57
|
-
|
|
58
|
-
1. One-line context ("You are integrating Superwall into a <X> app.")
|
|
59
|
-
2. Lifecycle checklist (markdown checkboxes)
|
|
60
|
-
3. Docs access block — always include:
|
|
61
|
-
```bash
|
|
62
|
-
curl -sL https://superwall.com/docs/llms.txt # index — find the path
|
|
63
|
-
curl -sL https://superwall.com/docs/{path}.md # any page as markdown
|
|
64
|
-
```
|
|
65
|
-
4. The steps — verified instructions plus the inline `curl -sL` for each
|
|
66
|
-
step's doc page (baked = fast and offline; fetched = source of truth)
|
|
67
|
-
5. Decision points as explicit branches
|
|
68
|
-
6. Verify section — build commands, what success looks like
|
|
69
|
-
7. Pitfalls — real ones with fixes
|
|
70
|
-
8. Deeper docs — the exact URLs used
|
|
71
|
-
|
|
72
|
-
`> **Important:**` callouts for critical steps; `→ references/x.md` arrows for
|
|
73
|
-
routing.
|
|
74
|
-
|
|
75
|
-
## Content rules
|
|
76
|
-
|
|
77
|
-
- **Verify every API against live docs before writing it.** Package ids,
|
|
78
|
-
version bounds, signatures, config keys — fetched, not remembered. If a doc
|
|
79
|
-
is ambiguous, write the step and add "confirm against <exact doc url>".
|
|
80
|
-
Never invent sample code for a path with no official doc.
|
|
81
|
-
- **Never exaggerate.** Migration skills carry a prominent "what does NOT
|
|
82
|
-
migrate" callout. Paywall designs are rebuilt — as code with the framework
|
|
83
|
-
or in the editor — and the skill says so. Craft guidance (where placements
|
|
84
|
-
go, how many, naming) is introduced as recommended practice, not passed off
|
|
85
|
-
as documentation.
|
|
86
|
-
- **Dashboard changes go through the CLI** (`superwall entitlements create …`,
|
|
87
|
-
`campaigns placement …`, `--json` everywhere) — never raw curl when a
|
|
88
|
-
command exists.
|
|
89
|
-
- **No harness protocol in skills.** `[STATUS]` lines and report formats come
|
|
90
|
-
from `prompts/`.
|
|
91
|
-
- **No customer specifics.** Placeholders are `pk_YOUR_PUBLIC_KEY`,
|
|
92
|
-
`AuthKey_<KEY_ID>.p8`, `<campaignId>`; pitfalls are written generically.
|
|
93
|
-
|
|
94
|
-
## Keeping skills in sync
|
|
95
|
-
|
|
96
|
-
Skills quote CLI commands constantly, and the public `superwall` skill
|
|
97
|
-
documents this CLI's whole surface. On any command change, sweep:
|
|
98
|
-
|
|
99
|
-
```bash
|
|
100
|
-
cd packages/cli && grep -rn "superwall <old>" skills prompts README.md
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
then `src/core/agent/actions.ts` (action vars, references),
|
|
104
|
-
`prompts/actions/*.xml` (task wrappers), and the `superwall` skill in
|
|
105
|
-
[superwall/skills](https://github.com/superwall/skills). Smoke the
|
|
106
|
-
composition with `superwall <workflow> --skill` in a fixture project of each
|
|
107
|
-
affected framework: right reference, no cross-framework leakage, no unresolved
|
|
108
|
-
`{{vars}}`.
|
|
109
|
-
|
|
110
|
-
## Before calling a skill done
|
|
111
|
-
|
|
112
|
-
- [ ] An agent with only `SKILL.md` + one reference in context could execute it
|
|
113
|
-
flawlessly — no missing steps, no assumed context.
|
|
114
|
-
- [ ] Zero unverified API names, or each flagged with its doc URL.
|
|
115
|
-
- [ ] Composition tested per framework; grep for leakage.
|
|
116
|
-
- [ ] Honesty pass: nothing promises more than the product does.
|
|
117
|
-
- [ ] `bun run test` — `tests/core/agent/skill-contracts.test.ts` checks the
|
|
118
|
-
files the loader expects exist.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/{skills/superwall-integrate/references → dist/skills/superwall/workflows/integrate}/expo.md
RENAMED
|
File without changes
|
|
File without changes
|
/package/{skills/superwall-integrate/references → dist/skills/superwall/workflows/integrate}/ios.md
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|