@siteoshq/cli 1.11.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 +17 -8
- package/dist/cli.js +18 -4
- package/dist/cli.js.map +1 -1
- package/package.json +3 -2
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
|
|
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
|
|
@@ -167,11 +167,17 @@ snippet is unavailable until runtime publication succeeds. Integrations connecti
|
|
|
167
167
|
Organization; provider authorization opens the shared browser flow, and notification destinations
|
|
168
168
|
are connected explicitly by each service.
|
|
169
169
|
|
|
170
|
-
### SEO
|
|
170
|
+
### SEO/GEO
|
|
171
171
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
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.
|
|
175
|
+
|
|
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.
|
|
175
181
|
|
|
176
182
|
```sh
|
|
177
183
|
siteos project connect seo --json
|
|
@@ -192,8 +198,8 @@ observed URL. Read the returned audit ID until a terminal state; a queued respon
|
|
|
192
198
|
`issue ignore` and `issue restore` require `--audit`, `--url`, `--rule`, `--reason` and the current
|
|
193
199
|
`--revision` (0 before the first decision). They use a distinct issue-write scope. Read back the
|
|
194
200
|
decision after success; a revision conflict requires refreshing it. Ignore never means resolved.
|
|
195
|
-
All SEO commands resolve the selected common Project and explicit environment binding.
|
|
196
|
-
|
|
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:
|
|
197
203
|
|
|
198
204
|
```sh
|
|
199
205
|
siteos seo research summary --json
|
|
@@ -209,7 +215,10 @@ siteos seo gsc export --dataset queries --format csv --output ./gsc-queries.csv
|
|
|
209
215
|
```
|
|
210
216
|
|
|
211
217
|
Run `siteos seo --help` for request JSON, limits, saved inputs, cancellation and GSC settings.
|
|
212
|
-
Research supports keywords,
|
|
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"}`.
|
|
213
222
|
Reading/planning/saving spends no research credits. Launch uses Organization credits and the same
|
|
214
223
|
server admission as the interface. Keep the retry key after an uncertain response; no paid retries
|
|
215
224
|
are automatic. Wait exit 3 means pending; exit 4 failed/cancelled. Partial evidence remains readable.
|
package/dist/cli.js
CHANGED
|
@@ -10520,7 +10520,9 @@ var RESEARCH_HELP = `
|
|
|
10520
10520
|
siteos seo research saved save --input <request.json> --name <name> [--id <saved-id>] [--environment <slug>] [--json]
|
|
10521
10521
|
siteos seo research saved remove <saved-id> [--environment <slug>] [--json]
|
|
10522
10522
|
|
|
10523
|
-
Research kinds: keywords,
|
|
10523
|
+
Research kinds: keywords, domain, rankings, backlinks, brand, ai-visibility.
|
|
10524
|
+
Domain Overview: {"kind":"domain","target":"example.com","country":"US","language":"en"}.
|
|
10525
|
+
Domain collects summary, ranking keywords, top pages and competitors. The legacy competitors kind retains its two-part plan; domain history includes those reports.
|
|
10524
10526
|
Request JSON: {"kind":"keywords","target":"example.com","keywords":["website analytics"],"country":"US","language":"en"}.
|
|
10525
10527
|
Rankings accepts up to 10 keywords and 5 competitors. AI visibility requires brand, prompt and platforms.
|
|
10526
10528
|
Markets: US, GB, ES, DE, FR, CA, AU. Languages: en, es, de, fr, pt, it, nl, ru.
|
|
@@ -10539,7 +10541,10 @@ var kinds = [
|
|
|
10539
10541
|
"brand",
|
|
10540
10542
|
"ai-visibility"
|
|
10541
10543
|
];
|
|
10542
|
-
var requestSchema = z19.object({
|
|
10544
|
+
var requestSchema = z19.object({
|
|
10545
|
+
kind: z19.enum(["domain", ...kinds]).transform((kind) => kind === "domain" ? "competitors" : kind),
|
|
10546
|
+
target: z19.string().min(1).max(253)
|
|
10547
|
+
}).passthrough();
|
|
10543
10548
|
var runStates = z19.enum([
|
|
10544
10549
|
"queued",
|
|
10545
10550
|
"running",
|
|
@@ -10596,6 +10601,7 @@ async function runSeoResearchCommand(options) {
|
|
|
10596
10601
|
throw new Error(
|
|
10597
10602
|
"Invalid research operation or flags. Run siteos seo --help."
|
|
10598
10603
|
);
|
|
10604
|
+
if (values.kind === "domain") values.kind = "competitors";
|
|
10599
10605
|
if (operation.flags.includes("kind") && !kinds.includes(values.kind))
|
|
10600
10606
|
throw new Error("Choose a documented --kind.");
|
|
10601
10607
|
if (operation.flags.includes("input") && !values.input)
|
|
@@ -11273,7 +11279,15 @@ async function runSeoPerformanceCommand(options) {
|
|
|
11273
11279
|
}
|
|
11274
11280
|
|
|
11275
11281
|
// src/services/seo-command.ts
|
|
11276
|
-
var SEO_HELP = `
|
|
11282
|
+
var SEO_HELP = `SEO/GEO: audit your website and research search-engine and AI visibility in the selected Project environment.
|
|
11283
|
+
|
|
11284
|
+
Site Audit checks public HTML, canonical, robots.txt, sitemap and technical GEO signals.
|
|
11285
|
+
Performance measures selected pages with Lighthouse and compares response/rendered HTML.
|
|
11286
|
+
Research covers keywords, rankings, competitors, backlinks, Brand lookup and Prompt checks.
|
|
11287
|
+
GSC Insights reads your connected property's Google Search Console data; other research needs no GSC.
|
|
11288
|
+
Technical GEO checks crawler policies, content, snippets and structured-data syntax/shape.
|
|
11289
|
+
These checks do not measure autonomous agent journeys or guarantee AI inclusion or citations.
|
|
11290
|
+
The service is named SEO/GEO in the application; its command remains siteos seo.
|
|
11277
11291
|
|
|
11278
11292
|
Usage:
|
|
11279
11293
|
siteos seo status [--environment <slug>] [--json]
|
|
@@ -11820,7 +11834,7 @@ Commands:
|
|
|
11820
11834
|
cookie Configure, publish, and inspect the Project\u2019s cookie banner.
|
|
11821
11835
|
trace Configure analytics observation and inspect evidence.
|
|
11822
11836
|
analytics Configure website Analytics, events and realtime reports.
|
|
11823
|
-
seo
|
|
11837
|
+
seo SEO/GEO audits, keyword research and AI visibility reports.
|
|
11824
11838
|
integrations Manage Organization connections and destinations.
|
|
11825
11839
|
pulse Manage monitoring checks, tests, and deployments.
|
|
11826
11840
|
search Run SiteOS search operations for a project environment.
|