@verisource/cli 0.0.0-stage → 1.0.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 +67 -2
- package/dist/bin.d.ts +20 -0
- package/dist/bin.js +11973 -0
- package/dist/browser.d.ts +75 -0
- package/dist/browser.js +432 -0
- package/dist/cloud.d.ts +79 -0
- package/dist/cloud.js +93 -0
- package/dist/github-pr.d.ts +24 -0
- package/dist/github-pr.js +129 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +8019 -0
- package/dist/logs.d.ts +17 -0
- package/dist/logs.js +168 -0
- package/dist/mapper.d.ts +36 -0
- package/dist/mapper.js +204 -0
- package/dist/skills.d.ts +5 -0
- package/dist/skills.js +45 -0
- package/dist/store.d.ts +56 -0
- package/dist/store.js +133 -0
- package/package.json +54 -3
package/README.md
CHANGED
|
@@ -1,3 +1,68 @@
|
|
|
1
|
-
#
|
|
1
|
+
# `@verisource/cli`
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Local-first AI Search GEO readiness scanner, 20-page site health crawler, codebase route mapper, and deterministic browser flow verifier for B2B engineering teams and coding agents.
|
|
4
|
+
|
|
5
|
+
Zero required runtime sub-dependencies. Run directly via `npx @verisource/cli` on Node.js 20+.
|
|
6
|
+
|
|
7
|
+
## Quickstart
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Audit AI bot WAF access, JSON-LD, /llms.txt, /agents.md, and 20-page link health
|
|
11
|
+
npx @verisource/cli scan https://verisource.dev
|
|
12
|
+
|
|
13
|
+
# Enforce deterministic CI thresholds (.verisource/checks.json -> exit 0, 1, or 2)
|
|
14
|
+
npx @verisource/cli verify https://verisource.dev --init
|
|
15
|
+
|
|
16
|
+
# Drill into a single compact finding handle instead of dumping raw HTML into context
|
|
17
|
+
npx @verisource/cli show h1
|
|
18
|
+
|
|
19
|
+
# Map static Next.js / React routes + JSON-LD emitters or crawl a live domain
|
|
20
|
+
npx @verisource/cli map . --diff
|
|
21
|
+
|
|
22
|
+
# Install compact agent instructions for Claude Code, Cursor, Codex, and Antigravity
|
|
23
|
+
npx @verisource/cli agent --skill --install all
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Command Reference
|
|
27
|
+
|
|
28
|
+
| Command | Purpose |
|
|
29
|
+
| :--- | :--- |
|
|
30
|
+
| `verisource auth [--key vs_live_...] [--status\|--logout]` | Authenticates your local or CI workspace against `/api/cli/sync` and stores `vs_live_` credentials in `.verisource/config.json` (`0o600`). |
|
|
31
|
+
| `verisource scan <url> [--push] [--json]` | Probes `GPTBot`, `OAI-SearchBot`, `PerplexityBot`, and `ClaudeBot` `robots.txt`/WAF rules, `JSON-LD` entities, `/llms.txt`, `/agents.md`, `/ai-facts`, and crawls up to 20 internal pages (`VerisourceScan/1.0`). |
|
|
32
|
+
| `verisource verify <url> [--init] [--push] [--json]` | Evaluates live readiness and link health against `.verisource/checks.json`. Returns exit `0` on pass, `1` on policy failure, and `2` on invalid input or network failure. |
|
|
33
|
+
| `verisource vs <domainA> <domainB> [--json] [--github-summary]` | Runs a 6-dimension Head-to-Head AI Search & Crawler Protocol X-Ray between two public domains and stores `[x1..xN]` overtake action handles. |
|
|
34
|
+
| `verisource report <domain> [--md] [--json]` | Fetches a pre-indexed domain scorecard or raw Markdown (`?format=md`) from `verisource.dev/api/report/<domain>` in milliseconds and stores `[r1]`. |
|
|
35
|
+
| `verisource matchup <slug \| domainA domainB> [--md] [--json]` | Fetches a pre-published 6-dimension Head-to-Head Matchup JSON or raw Markdown (`?format=md`) from `verisource.dev/api/vs/<slug>` and stores `[m1]`. |
|
|
36
|
+
| `verisource show <handle> [--json]` | Prints full metadata and remediation hints for a single stored handle (`h1` hallucination, `b1` bot/WAF block, `l1` broken link, `a1` dead `#anchor`, `n1` HTTP error, `g1` backend log, `e1` DOM element, `x1` rivalry gap, `r1` scorecard gap, `m1` matchup gap). |
|
|
37
|
+
| `verisource query "<text>" [--json]` | Searches `.verisource/last-run.json` handles by status code, route, or keyword. |
|
|
38
|
+
| `verisource map [url \| ./dir] [--find <q>] [--diff]` | Maps live domain links or static Next.js App Router / Pages Router routes, API handlers, and `application/ld+json` emitters. |
|
|
39
|
+
| `verisource browse <open\|click\|save> <arg>` | Opens a page into compact `[e1..eN]` element handles, follows links, and exports deterministic JSON specs to `.verisource/workflows/`. |
|
|
40
|
+
| `verisource record <name> <url>` | Captures a baseline HTTP + `JSON-LD` verification workflow into `.verisource/workflows/<name>.json`. |
|
|
41
|
+
| `verisource run [name] [--headed] [--json]` | Replays saved `.verisource/workflows/*.json` suites with zero LLM calls (uses local Playwright Chromium automatically when installed for interactive steps). |
|
|
42
|
+
| `verisource workflow check` | Validates every `.verisource/workflows/*.json` file before CI commit. |
|
|
43
|
+
| `verisource log <vercel\|supabase\|cloudflare>` | Queries local NDJSON or token-authenticated provider error logs within the last 5-minute window. |
|
|
44
|
+
| `verisource agent --skill --install <target>` | Writes Verisource CLI & MCP workflow rules for `claude`, `cursor`, `codex`, `antigravity`, or `all`. |
|
|
45
|
+
|
|
46
|
+
## GitHub Actions CI Gate
|
|
47
|
+
|
|
48
|
+
```yaml
|
|
49
|
+
- name: Verisource AI Search & Site Health Gate
|
|
50
|
+
uses: kulinichnick/verisource@main
|
|
51
|
+
with:
|
|
52
|
+
url: ${{ env.PREVIEW_URL }}
|
|
53
|
+
min-visibility-score: '65'
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Or run the CLI directly with native `$GITHUB_STEP_SUMMARY` Markdown tables:
|
|
57
|
+
|
|
58
|
+
```yaml
|
|
59
|
+
- name: Verify AI Search Readiness & Site Health
|
|
60
|
+
run: npx @verisource/cli verify ${{ env.PREVIEW_URL }} --github-summary
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Documentation & MCP Server
|
|
64
|
+
|
|
65
|
+
- Platform Capabilities: https://verisource.dev/features
|
|
66
|
+
- Crawler Transparency (`VerisourceScan/1.0`): https://verisource.dev/scanner
|
|
67
|
+
- Streamable HTTP MCP Endpoint: https://mcp.verisource.dev/mcp
|
|
68
|
+
- Agent Specification: https://verisource.dev/agents.md
|
package/dist/bin.d.ts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { type PublicHeadToHeadXrayReport } from '@verisource/core-geo';
|
|
2
|
+
import { type StoredHandleItem } from './store.js';
|
|
3
|
+
export declare function buildGithubStepSummaryMarkdown(params: {
|
|
4
|
+
mode: 'scan' | 'verify';
|
|
5
|
+
status: 'PASS' | 'WARN' | 'FAIL';
|
|
6
|
+
hostname: string;
|
|
7
|
+
detectedPlatformLabel?: string;
|
|
8
|
+
visibilityScore: number;
|
|
9
|
+
healthScore: number;
|
|
10
|
+
pagesScanned: number;
|
|
11
|
+
linksChecked: number;
|
|
12
|
+
botsAllowed: boolean;
|
|
13
|
+
llmsTxtStatus: string;
|
|
14
|
+
agentsMdStatus: string;
|
|
15
|
+
jsonLdCount: number;
|
|
16
|
+
failures?: string[];
|
|
17
|
+
handles?: StoredHandleItem[];
|
|
18
|
+
}): string;
|
|
19
|
+
export declare function buildGithubVsSummaryMarkdown(report: PublicHeadToHeadXrayReport): string;
|
|
20
|
+
export declare function runCli(argv: string[], cwd?: string): Promise<number>;
|