@drip-apex/apex-cli 0.5.0 → 0.6.1
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/AGENTS.md +4 -3
- package/README.md +34 -5
- package/dist/cli.js +6033 -3048
- package/package.json +6 -2
- package/skills/apex-cli/SKILL.md +1 -1
package/AGENTS.md
CHANGED
|
@@ -4,7 +4,7 @@ Use `apex` as the canonical command name. `drip` is a compatibility alias.
|
|
|
4
4
|
|
|
5
5
|
## Canonical Loop
|
|
6
6
|
|
|
7
|
-
1. `apex experiments pull <id-or-slug> --
|
|
7
|
+
1. `apex experiments pull <id-or-slug> --out <folder>`
|
|
8
8
|
2. Edit only supported files in the pulled folder.
|
|
9
9
|
3. `apex experiments plan <folder> --json`
|
|
10
10
|
4. `apex experiments apply <folder> --json`
|
|
@@ -47,8 +47,8 @@ the first writes: `apex experiments create`, `apex goals create`,
|
|
|
47
47
|
|
|
48
48
|
## Recovery
|
|
49
49
|
|
|
50
|
-
- Missing auth: run `apex login` interactively, or set `
|
|
51
|
-
- Headless login: pass `--api-key` or set `
|
|
50
|
+
- Missing auth: run `apex login` interactively, or set `APEX_API_KEY`.
|
|
51
|
+
- Headless login: pass `--api-key` or set `APEX_API_KEY`; `DRIP_API_KEY` remains a compatibility fallback.
|
|
52
52
|
- Do not wait for prompts in CI or agent runs. If a command returns exit `4`, rerun with the exact flag named in the JSON error details only after checking the plan or destructive action.
|
|
53
53
|
- Apply invalidates QA: inspect `apex experiments plan`, then rerun apply with `--force` if intended.
|
|
54
54
|
- Stale workspace or filesystem: pull fresh files, reapply your edits, and plan again.
|
|
@@ -56,6 +56,7 @@ the first writes: `apex experiments create`, `apex goals create`,
|
|
|
56
56
|
|
|
57
57
|
## Filesystem Rules
|
|
58
58
|
|
|
59
|
+
- Formatting is enforced by Biome (`npm run format`); do not hand-wrap code.
|
|
59
60
|
- Treat `.apex/` as CLI-owned metadata.
|
|
60
61
|
- Edit experiment files, variation code, metrics, and targeting only through supported paths.
|
|
61
62
|
- Do not bypass the variation artifact persistence path with direct API writes.
|
package/README.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# Apex CLI
|
|
2
2
|
|
|
3
|
+
## Purchase-capture verification
|
|
4
|
+
|
|
5
|
+
The CLI exposes a read-only, publication-anchored purchase verification battery:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
apex shops doctor --check purchase_capture
|
|
9
|
+
apex tracking verify --event-type goal,conversion,purchase,checkout_completed,order_created --minutes 10080
|
|
10
|
+
apex install check --shop-id "$APEX_SHOP_ID"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
`purchase_capture` reports `OK`, `DARK`, or `NO_DATA`; a young window or unknown historical cadence
|
|
14
|
+
is `NO_DATA`, never a healthy result. Tracking verification renders compact event-property previews
|
|
15
|
+
in human mode and preserves complete properties in `--json`. Install checks report the served
|
|
16
|
+
`dataLayerTriggers` count and whether an enabled revenue trigger exists.
|
|
17
|
+
|
|
3
18
|
## Authentication and context
|
|
4
19
|
|
|
5
20
|
Run `apex login` once to authenticate your account. Interactive login opens
|
|
@@ -16,7 +31,7 @@ stdout. Flags and environment variables are explicit choices and stay silent.
|
|
|
16
31
|
JSON envelopes echo the effective org, shop, and credential kind.
|
|
17
32
|
|
|
18
33
|
Automation should continue injecting a narrow shop key per process with
|
|
19
|
-
`
|
|
34
|
+
`APEX_API_KEY`; it takes precedence over a stored user credential and does not
|
|
20
35
|
change the stored login. Use `apex login --api-key apx_uk_...` for a headless
|
|
21
36
|
account login or `apex login --api-key apx_...` to store a shop key. The old
|
|
22
37
|
`apex login --user` spelling is a deprecated alias for `apex login`.
|
|
@@ -42,7 +57,7 @@ headless environments, use an existing API key:
|
|
|
42
57
|
|
|
43
58
|
```bash
|
|
44
59
|
apex login --api-key apx_your_key_here
|
|
45
|
-
|
|
60
|
+
APEX_API_KEY=apx_your_key_here apex experiments list --json
|
|
46
61
|
```
|
|
47
62
|
|
|
48
63
|
## Common usage
|
|
@@ -83,13 +98,28 @@ including every subcommand, argument, option, and alias.
|
|
|
83
98
|
- `apex login` — authenticate with a shop or user API key.
|
|
84
99
|
- `apex logout` — remove stored credentials.
|
|
85
100
|
- `apex whoami` — inspect the current credential and its validity.
|
|
101
|
+
- `apex use` — select the current organization and shop context.
|
|
86
102
|
- `apex account` — manage the current user profile.
|
|
87
103
|
- `apex keys` — manage shop API keys.
|
|
88
104
|
- `apex org` — inspect and manage the organization.
|
|
89
|
-
- `apex team` — manage
|
|
105
|
+
- `apex team` — manage shop-scoped members and invitations.
|
|
90
106
|
|
|
91
107
|
### Experiments and delivery
|
|
92
108
|
|
|
109
|
+
- `apex consent` — manage consent gating.
|
|
110
|
+
- `apex triggers` — manage data-layer triggers and temporary setup capture.
|
|
111
|
+
- `apex triggers get --shop <domain-or-id>` — read the identified shop's runtime triggers.
|
|
112
|
+
- `apex triggers set` — replace the shop's runtime triggers from a JSON file.
|
|
113
|
+
- `apex triggers propose` — propose candidate triggers from a discovery report.
|
|
114
|
+
- `apex triggers apply-recipe` — apply a server-owned trigger recipe.
|
|
115
|
+
- `apex triggers enable-capture` — enable temporary setup capture.
|
|
116
|
+
- `apex triggers disable-capture` — disable setup capture and clear its expiry.
|
|
117
|
+
- `apex domains` — manage install domains.
|
|
118
|
+
- `apex handover` — manage cross-domain identity handover.
|
|
119
|
+
- `apex install` — generate storefront installation snippets.
|
|
120
|
+
- `apex funnels` — manage analytics funnels.
|
|
121
|
+
- `apex webhooks` — manage shop webhooks.
|
|
122
|
+
- `apex simulate` — simulate data-layer triggers without emitting events.
|
|
93
123
|
- `apex experiments` — create, inspect, operate, and synchronize experiments.
|
|
94
124
|
Use `apex experiments screenshots <id-or-slug>` to force-assign every capture, including control, to its variation server-side for deterministic screenshots; choose devices with `--devices`, filter treatments with `--variations`, and use `--json` for the signed result payload.
|
|
95
125
|
- `apex push` — synchronize `.drip.config.ts` with Apex.
|
|
@@ -121,11 +151,10 @@ including every subcommand, argument, option, and alias.
|
|
|
121
151
|
- `apex assets` — manage uploaded assets.
|
|
122
152
|
- `apex landing-pages` — discover landing pages.
|
|
123
153
|
- `apex brand` — manage brand context.
|
|
124
|
-
- `apex sos` — run operational diagnostics.
|
|
125
154
|
- `apex shops` — manage shops and active-shop context.
|
|
126
155
|
- `apex skills` — inspect agent skill guidance.
|
|
127
|
-
- `apex admin` — run authorized administrative operations.
|
|
128
156
|
- `apex schema` — emit the machine-readable CLI schema.
|
|
157
|
+
- `apex discover` — read observed tracking shapes or mine a public GTM container.
|
|
129
158
|
|
|
130
159
|
## Which local format am I in?
|
|
131
160
|
|