@siteoshq/cli 1.6.0 → 1.8.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 +40 -1
- package/dist/cli.js +691 -181
- package/dist/cli.js.map +1 -1
- package/package.json +20 -21
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# SiteOS CLI
|
|
2
2
|
|
|
3
3
|
`@siteoshq/cli` exposes one `siteos` binary for Auth, common Projects, Pulse, Cookie, Forms,
|
|
4
|
-
Search, Trace, SEO and Integrations. This source prepares version 1.
|
|
4
|
+
Search, Trace, SEO and Integrations. This source prepares version 1.8.0; publishing is a separate release.
|
|
5
5
|
Node.js 22 or newer is required.
|
|
6
6
|
|
|
7
7
|
## Install and authenticate
|
|
@@ -125,12 +125,28 @@ siteos project connect trace --json
|
|
|
125
125
|
siteos trace environments --json
|
|
126
126
|
siteos trace installation show --environment production --json
|
|
127
127
|
siteos trace report --environment production --json
|
|
128
|
+
siteos trace destinations --environment production --json
|
|
129
|
+
siteos trace events --environment production --provider ga4 --period 7d --json
|
|
130
|
+
siteos trace issues --environment production --state active --json
|
|
131
|
+
siteos trace observations --environment production --provider ga4 --event purchase --json
|
|
128
132
|
siteos integrations status --json
|
|
129
133
|
siteos integrations connect --json
|
|
130
134
|
```
|
|
131
135
|
|
|
132
136
|
Cookie/Trace draft editing and publication are separate commands with separate authorization
|
|
133
137
|
scopes. Save commands take versioned JSON input; inspect `--help` and the focused plugin skill.
|
|
138
|
+
|
|
139
|
+
Trace explorer commands require CLI 1.8.0 and the corresponding Trace server release. They return
|
|
140
|
+
one page with `items`, `total`, `nextCursor`, `from` and `to`. Repeat the same filters with
|
|
141
|
+
`--cursor <nextCursor>` to continue; omit the cursor to refresh the window. `trace issue show --id
|
|
142
|
+
<uuid>` reads finding history, and `trace observation show --batch-id <uuid> --event-id <uuid>`
|
|
143
|
+
reads a specific observation. These commands use read authority and the explicit Project
|
|
144
|
+
environment binding. `custom` means the data layer source, not a confirmed destination.
|
|
145
|
+
|
|
146
|
+
After reviewing a tracking plan, use `trace tracking-plan publish --expected-draft-version
|
|
147
|
+
<number>` to publish that version. A conflict must be reread and reviewed; do not retry without
|
|
148
|
+
the version guard. Existing installation and report commands remain compatible. Deployment of
|
|
149
|
+
the Trace server and runtime precedes announcing the new explorer commands in the public plugin.
|
|
134
150
|
Installation commands return the service-owned snippet and actual publication state. A Trace
|
|
135
151
|
snippet is unavailable until runtime publication succeeds. Integrations connections belong to the
|
|
136
152
|
Organization; provider authorization opens the shared browser flow, and notification destinations
|
|
@@ -281,3 +297,26 @@ Definitions include a generated SHA-256 `sourceExportId`; runtime sends it as `c
|
|
|
281
297
|
A changed field requires a normal build/release, not a second hand-edited validation schema.
|
|
282
298
|
`forms deployment-key list|revoke` manages release keys; submission keys cannot publish.
|
|
283
299
|
See the SiteOS Forms skill for the portable generator and version serialization contract.
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
## Website Analytics
|
|
303
|
+
|
|
304
|
+
The source CLI includes `siteos analytics` for an explicitly connected Project environment. Check
|
|
305
|
+
`siteos analytics --help` against the installed package and server before use; source availability
|
|
306
|
+
does not establish publication. Start with `project status`, `analytics status` and
|
|
307
|
+
`analytics installation`. Use `--environment <slug>` when selecting the target explicitly.
|
|
308
|
+
|
|
309
|
+
`analytics settings show` returns the current revision. `analytics settings set --revision <n>`
|
|
310
|
+
accepts partial `--enabled true|false`, `--cookie-events true|false` and
|
|
311
|
+
`--minimal-realtime true|false` updates. Analytics collects independently by default. Native consent
|
|
312
|
+
control belongs to Cookie's published `integrations.siteosAnalytics` switch in the same Project
|
|
313
|
+
environment; attachment or a draft save does not enable it. External CMP gating is optional and
|
|
314
|
+
must be configured before runtime initialization. Privacy signals and full opt-out still apply.
|
|
315
|
+
Reload the website after configuration changes.
|
|
316
|
+
|
|
317
|
+
`analytics events list|create|snippet`, campaigns, goals and funnels manage reviewed categorical
|
|
318
|
+
definitions. Creation uses `--file <definition.json>`; reports and realtime read accepted data.
|
|
319
|
+
`analytics monitoring prepare` prepares a Trace draft without publishing it. Auth grants are scoped
|
|
320
|
+
to Analytics and the operation, with editor roles required for writes. Analytics is Unlimited in
|
|
321
|
+
Usage during early access. See the canonical plugin's website Analytics skill for event contracts
|
|
322
|
+
and the browser-to-report verification workflow; Search reports use `search analytics` separately.
|