@siteoshq/cli 1.10.0 → 1.12.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 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.10.0; publishing is a separate release.
4
+ Search, Trace, SEO/GEO and Integrations. This source is version 1.11.0; source changes require a separate release to reach npm.
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
@@ -161,11 +167,17 @@ snippet is unavailable until runtime publication succeeds. Integrations connecti
161
167
  Organization; provider authorization opens the shared browser flow, and notification destinations
162
168
  are connected explicitly by each service.
163
169
 
164
- ### SEO (prepared for release)
170
+ ### SEO/GEO
171
+
172
+ The application calls this service **SEO/GEO**; its command and Project service key remain `seo`.
173
+ GEO means generative engine optimization, including technical AI-search accessibility and
174
+ AI mentions/citations. Check `siteos seo --help` against the installed CLI and server version.
165
175
 
166
- Check `siteos seo --help` before use; install a matching release only after it is published. An
167
- SEO-capable server returns SEO in its Project service catalog, which older strict CLI parsers may
168
- reject. Coordinate the CLI update before that server rollout, then publish the matching plugin.
176
+ Site Audit checks public HTML, canonical, robots.txt, sitemaps, snippets and basic structured data.
177
+ Its crawler-policy checks do not prove access from actual provider IPs. Performance adds
178
+ selected-page Lighthouse and response/rendered HTML comparisons. Brand lookup and Prompt checks
179
+ provide separate AI visibility evidence. No autonomous agent journey or target API/MCP audit is
180
+ performed by these commands, and no result guarantees AI inclusion or a universal AI rank.
169
181
 
170
182
  ```sh
171
183
  siteos project connect seo --json
@@ -186,7 +198,40 @@ observed URL. Read the returned audit ID until a terminal state; a queued respon
186
198
  `issue ignore` and `issue restore` require `--audit`, `--url`, `--rule`, `--reason` and the current
187
199
  `--revision` (0 before the first decision). They use a distinct issue-write scope. Read back the
188
200
  decision after success; a revision conflict requires refreshing it. Ignore never means resolved.
189
- All SEO commands resolve the selected common Project and explicit environment binding. Current
201
+ All SEO/GEO commands resolve the selected common Project and explicit environment binding.
202
+ Research and GSC Insights use these commands with a matching server release:
203
+
204
+ ```sh
205
+ siteos seo research summary --json
206
+ siteos seo research history --kind keywords --json
207
+ siteos seo research show <run-id> --json
208
+ siteos seo research plan --input ./research-request.json --json
209
+ siteos seo research run --input ./research-request.json --idempotency-key <retry-key> --json
210
+ siteos seo research wait <run-id> --json
211
+ siteos seo research export <run-id> --format json --output ./research-report.json --json
212
+ siteos seo gsc status --json
213
+ siteos seo gsc report --dataset queries --filter all --json
214
+ siteos seo gsc export --dataset queries --format csv --output ./gsc-queries.csv --json
215
+ ```
216
+
217
+ Run `siteos seo --help` for request JSON, limits, saved inputs, cancellation and GSC settings.
218
+ Research supports keywords, Domain Overview (`domain`), rankings, backlinks, brand and AI visibility without GSC.
219
+ Domain Overview collects domain totals, up to 100 ranking keywords, pages and competitors for a market.
220
+ `--kind domain` includes legacy `competitors` history; existing `competitors` inputs keep their original two-part plan.
221
+ New request example: `{"kind":"domain","target":"example.com","country":"US","language":"en"}`.
222
+ Reading/planning/saving spends no research credits. Launch uses Organization credits and the same
223
+ server admission as the interface. Keep the retry key after an uncertain response; no paid retries
224
+ are automatic. Wait exit 3 means pending; exit 4 failed/cancelled. Partial evidence remains readable.
225
+ Exports retain scope/coverage and refuse overwrite. Research CSV includes JSON cells for request,
226
+ dataset metadata and rows; JSON is preferable for programmatic analysis.
227
+
228
+ GSC uses saved comparisons and an explicitly connected property. Reports page by 25; exports include
229
+ all matching normalized rows, up to the 20,000-row current/previous union bound. `gsc sync` queues the
230
+ Google worker without research credits. Google OAuth remains interactive; `gsc bind`/`disconnect`
231
+ manage only this environment with revision checks. Separate grants control research read/run/write
232
+ and GSC read/sync/write. Audit authority alone never enables paid research. These source capabilities
233
+ require coordinated CLI/server/plugin publication; they are not a claim about the current npm version.
234
+
190
235
  Auth policy permits CLI service-grant issuance to Organization owners/admins. JSON uses contract
191
236
  version 1 and does not include credentials. The focused plugin skill is `siteos-seo`.
192
237