@siteoshq/cli 1.13.0 → 2.1.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 +29 -25
- package/dist/cli.js +936 -2525
- package/dist/cli.js.map +1 -1
- package/package.json +18 -20
package/README.md
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
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/GEO and Integrations. This source is version 1.
|
|
4
|
+
Search, Trace, SEO/GEO and Integrations. This source is version 2.1.0; source changes require a separate release to reach npm.
|
|
5
|
+
|
|
6
|
+
CLI 2 requires `siteos project use <id-or-slug> --environment <slug>` once per repository.
|
|
7
|
+
It stores only the common selection in private `projects.json`; older service bindings are not
|
|
8
|
+
read or imported. Authentication and installed runtime/deployment credentials remain valid.
|
|
9
|
+
Service-local `project` and `environment` commands have been removed; use `siteos project`.
|
|
10
|
+
|
|
5
11
|
Node.js 22 or newer is required.
|
|
6
12
|
|
|
7
13
|
## Install and authenticate
|
|
@@ -74,7 +80,7 @@ Manage names and website URLs with `project update` and `project environment upd
|
|
|
74
80
|
Cookie/Trace published addresses remain unchanged until explicit republication.
|
|
75
81
|
|
|
76
82
|
`project use` writes one private binding keyed by real repository path and application origin in
|
|
77
|
-
`~/.siteos/
|
|
83
|
+
`~/.siteos/projects.json`. It does not write a tracked global Project file. All service
|
|
78
84
|
management commands use this selection and their own runtime authority. An Organization mismatch
|
|
79
85
|
requires selecting the Project in the active Organization again.
|
|
80
86
|
|
|
@@ -84,7 +90,7 @@ requires selecting the Project in the active Organization again.
|
|
|
84
90
|
|
|
85
91
|
```sh
|
|
86
92
|
siteos project connect pulse --json
|
|
87
|
-
siteos
|
|
93
|
+
siteos project status --json
|
|
88
94
|
siteos pulse init
|
|
89
95
|
siteos pulse validate --json
|
|
90
96
|
siteos pulse test
|
|
@@ -99,8 +105,7 @@ monitoring are explicit operations. `deploy --dry-run` builds locally without up
|
|
|
99
105
|
In a monorepo, run Pulse commands from the directory containing that website's
|
|
100
106
|
`siteos.config.json`. The current source resolves deployment configuration, specs and archive
|
|
101
107
|
output from that directory; private Project selection remains scoped to the Git repository.
|
|
102
|
-
|
|
103
|
-
Use a locally built CLI containing the fix until its separate npm release is available.
|
|
108
|
+
Nested website deployments resolve files relative to that website while retaining the repository’s common Project selection.
|
|
104
109
|
|
|
105
110
|
CLI 1.10.0 adds an optional `environmentVariables` array to each Check, for
|
|
106
111
|
example `"environmentVariables": ["TEST_EMAIL", "TEST_INBOX_TOKEN"]`. Declare names only, and set
|
|
@@ -114,11 +119,11 @@ earlier published versions do not preserve these declarations. See
|
|
|
114
119
|
### Forms and Search
|
|
115
120
|
|
|
116
121
|
```sh
|
|
117
|
-
siteos
|
|
122
|
+
siteos project environment list --json
|
|
118
123
|
siteos forms definition check --manifest .siteos/forms/manifest.json --json
|
|
119
124
|
siteos forms definition sync --environment production --manifest .siteos/forms/manifest.json --json
|
|
120
125
|
siteos forms credential issue --environment production --install --json
|
|
121
|
-
siteos
|
|
126
|
+
siteos project environment list --json
|
|
122
127
|
siteos search diagnostics --environment production --json
|
|
123
128
|
siteos search credential issue --environment production --install --json
|
|
124
129
|
siteos search indexing-credential issue --environment production --install --json
|
|
@@ -188,11 +193,16 @@ siteos seo audit show '<audit-id>' --json
|
|
|
188
193
|
siteos seo pages --audit '<audit-id>' --json
|
|
189
194
|
siteos seo issues --audit '<audit-id>' --json
|
|
190
195
|
siteos seo changes --audit '<audit-id>' --state resolved --json
|
|
191
|
-
siteos seo
|
|
196
|
+
siteos seo repair --audit '<audit-id>' --url https://example.com/pricing --rule metadata.description_missing --json
|
|
197
|
+
siteos seo recheck --audit '<audit-id>' --url https://example.com/pricing --url https://example.com/about --json
|
|
192
198
|
```
|
|
193
199
|
|
|
194
|
-
Setup performs no crawl. `audit run` queues a full HTML audit; `recheck` queues
|
|
195
|
-
|
|
200
|
+
Setup performs no crawl. `audit run` queues a full HTML audit; `recheck` queues 1–20 explicitly selected, previously observed URLs.
|
|
201
|
+
CLI 2.1.0 adds `repair` and repeated recheck `--url` values. The optional `--resource` guard
|
|
202
|
+
rejects a different Project environment before sending the request. Repair briefs read saved
|
|
203
|
+
evidence without an AI call; they do not authorize a deployment or another audit.
|
|
204
|
+
Full HTML audits allow 1–500 pages (default 100); the selected server and saved settings enforce
|
|
205
|
+
that limit independently of the installed CLI version. Read the returned audit ID until a terminal state; a queued response is not a result.
|
|
196
206
|
`audit cancel '<audit-id>'` revokes further work. Pages and changes are paginated with `--page`.
|
|
197
207
|
|
|
198
208
|
`issue ignore` and `issue restore` require `--audit`, `--url`, `--rule`, `--reason` and the current
|
|
@@ -247,33 +257,27 @@ version 1 and does not include credentials. The focused plugin skill is `siteos-
|
|
|
247
257
|
siteos health-check --json
|
|
248
258
|
```
|
|
249
259
|
|
|
250
|
-
Diagnostics report
|
|
251
|
-
or reading runtime credentials. A selected Project means local setup exists, not remote health.
|
|
260
|
+
Diagnostics report the common Project selection and local Pulse configuration without contacting
|
|
261
|
+
APIs or reading runtime credentials. A selected Project means local setup exists, not remote health.
|
|
252
262
|
Set `SITEOS_HOME` to relocate private CLI state. Never commit `auth.json` or private bindings.
|
|
253
263
|
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
old shared API keys are not imported or interpreted.
|
|
259
|
-
|
|
260
|
-
The retained Pulse migration can import a matching version 2 private binding from
|
|
261
|
-
`${XDG_CONFIG_HOME:-~/.config}/siteos/pulse/project-bindings.json` only when the origin, repository,
|
|
262
|
-
Organization and tracked Pulse slug agree. It leaves the original file untouched.
|
|
264
|
+
CLI 2 uses only `siteos project` for Project selection, service setup and environments. Service-local
|
|
265
|
+
Project and environment commands and binding imports have been removed. Re-select existing Projects
|
|
266
|
+
with `project use`; this preserves their data, attachments and credentials. Module resource IDs are
|
|
267
|
+
internal references, not common Project IDs or browser URLs.
|
|
263
268
|
|
|
264
269
|
## Origins and errors
|
|
265
270
|
|
|
266
271
|
`SITEOS_AUTH_BASE_URL` selects the shared application origin for common Projects and all service
|
|
267
|
-
commands using that context (default `https://app.siteos.sh`).
|
|
268
|
-
`SITEOS_PULSE_API_URL`, `SITEOS_FORMS_PUBLIC_URL` and `SITEOS_SEARCH_PUBLIC_URL` overrides. Runtime
|
|
272
|
+
commands using that context (default `https://app.siteos.sh`). Runtime
|
|
269
273
|
integration uses its service's configured public URL and scoped credential.
|
|
270
274
|
|
|
271
275
|
Run `siteos <group> --help` for supported commands. Exit code 0 means success, 2 invalid usage,
|
|
272
|
-
and 1 an operational failure.
|
|
276
|
+
and 1 an operational failure. Pulse additionally uses 3, 4 and 5 for authorization,
|
|
273
277
|
conflict and unavailable-service failures. JSON output is intended for agents and automation.
|
|
274
278
|
|
|
275
279
|
One SiteOS plugin supports Codex and Claude Code, with a general workflow and focused service
|
|
276
|
-
skills.
|
|
280
|
+
skills. The current common-only workflow requires CLI 2.0.0 and plugin 2.0.0.
|
|
277
281
|
|
|
278
282
|
## Development and publication checks
|
|
279
283
|
|