@siteoshq/cli 1.10.0 → 1.11.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 +37 -1
- package/dist/cli.js +753 -108
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
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.11.0; publishing is a separate release.
|
|
5
5
|
Node.js 22 or newer is required.
|
|
6
6
|
|
|
7
7
|
## Install and authenticate
|
|
@@ -96,6 +96,12 @@ the bound Pulse resource and current URL; local tests use this URL unless explic
|
|
|
96
96
|
`siteos.config.json` remains the tracked Playwright check configuration. Deployment and enabling
|
|
97
97
|
monitoring are explicit operations. `deploy --dry-run` builds locally without uploading.
|
|
98
98
|
|
|
99
|
+
In a monorepo, run Pulse commands from the directory containing that website's
|
|
100
|
+
`siteos.config.json`. The current source resolves deployment configuration, specs and archive
|
|
101
|
+
output from that directory; private Project selection remains scoped to the Git repository.
|
|
102
|
+
This fixes published CLI 1.10.0, which incorrectly bundled the repository root on deployment.
|
|
103
|
+
Use a locally built CLI containing the fix until its separate npm release is available.
|
|
104
|
+
|
|
99
105
|
CLI 1.10.0 adds an optional `environmentVariables` array to each Check, for
|
|
100
106
|
example `"environmentVariables": ["TEST_EMAIL", "TEST_INBOX_TOKEN"]`. Declare names only, and set
|
|
101
107
|
values in Pulse Settings for the selected Environment. The runner exposes declared values through
|
|
@@ -187,6 +193,36 @@ observed URL. Read the returned audit ID until a terminal state; a queued respon
|
|
|
187
193
|
`--revision` (0 before the first decision). They use a distinct issue-write scope. Read back the
|
|
188
194
|
decision after success; a revision conflict requires refreshing it. Ignore never means resolved.
|
|
189
195
|
All SEO commands resolve the selected common Project and explicit environment binding. Current
|
|
196
|
+
The source CLI also supports SEO research and GSC Insights with a matching server release:
|
|
197
|
+
|
|
198
|
+
```sh
|
|
199
|
+
siteos seo research summary --json
|
|
200
|
+
siteos seo research history --kind keywords --json
|
|
201
|
+
siteos seo research show <run-id> --json
|
|
202
|
+
siteos seo research plan --input ./research-request.json --json
|
|
203
|
+
siteos seo research run --input ./research-request.json --idempotency-key <retry-key> --json
|
|
204
|
+
siteos seo research wait <run-id> --json
|
|
205
|
+
siteos seo research export <run-id> --format json --output ./research-report.json --json
|
|
206
|
+
siteos seo gsc status --json
|
|
207
|
+
siteos seo gsc report --dataset queries --filter all --json
|
|
208
|
+
siteos seo gsc export --dataset queries --format csv --output ./gsc-queries.csv --json
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
Run `siteos seo --help` for request JSON, limits, saved inputs, cancellation and GSC settings.
|
|
212
|
+
Research supports keywords, rankings, competitors, backlinks, brand and AI visibility without GSC.
|
|
213
|
+
Reading/planning/saving spends no research credits. Launch uses Organization credits and the same
|
|
214
|
+
server admission as the interface. Keep the retry key after an uncertain response; no paid retries
|
|
215
|
+
are automatic. Wait exit 3 means pending; exit 4 failed/cancelled. Partial evidence remains readable.
|
|
216
|
+
Exports retain scope/coverage and refuse overwrite. Research CSV includes JSON cells for request,
|
|
217
|
+
dataset metadata and rows; JSON is preferable for programmatic analysis.
|
|
218
|
+
|
|
219
|
+
GSC uses saved comparisons and an explicitly connected property. Reports page by 25; exports include
|
|
220
|
+
all matching normalized rows, up to the 20,000-row current/previous union bound. `gsc sync` queues the
|
|
221
|
+
Google worker without research credits. Google OAuth remains interactive; `gsc bind`/`disconnect`
|
|
222
|
+
manage only this environment with revision checks. Separate grants control research read/run/write
|
|
223
|
+
and GSC read/sync/write. Audit authority alone never enables paid research. These source capabilities
|
|
224
|
+
require coordinated CLI/server/plugin publication; they are not a claim about the current npm version.
|
|
225
|
+
|
|
190
226
|
Auth policy permits CLI service-grant issuance to Organization owners/admins. JSON uses contract
|
|
191
227
|
version 1 and does not include credentials. The focused plugin skill is `siteos-seo`.
|
|
192
228
|
|