II.
Page reference
Reading · 3 minpage:docs-generated-cli-examples-verification
CLI Example Verification Index reference
Generated by scripts/generate-cli-examples-artifacts.cjs.
CLI Example Verification Index
Generated by scripts/generate-cli-examples-artifacts.cjs. Last refreshed: 2026-06-07.
Published surfaces: docs/cli-examples.md, packages/babysitter-sdk/src/testing/README.md, and library/reference/sdk.md.
Canonical Workflow
| Step | Command | Implementation | Artifact |
|---|---|---|---|
| Install workspace dependencies from a fresh checkout | npm ci | package-lock.json | node_modules/ |
| Build the SDK CLI used by the smoke harness | npm run build --workspace=@a5c-ai/babysitter-sdk | packages/babysitter-sdk/package.json#scripts.build | packages/babysitter-sdk/dist/ |
| Generate repo docs artifacts, including this traceability index | npm run docs:prepare | package.json#scripts.docs:prepare | docs/generated/cli-examples-verification.md |
| Run the real CLI smoke harness | npm run docs:examples:smoke | package.json#scripts.docs:examples:smoke | packages/babysitter-sdk/test-fixtures/cli/runs/smoke/ |
| Validate fenced code samples and command references in staged docs | npm run docs:snippets | package.json#scripts.docs:snippets | artifacts/docs-qa/docs-code-samples-report.json |
| Run the full docs quality suite | npm run docs:qa | package.json#scripts.docs:qa | artifacts/docs-qa/ |
Verification Matrix
| Docs Surface | Verification Command | Backing Implementation | Reviewable Evidence |
|---|---|---|---|
| CLI walkthrough command flow in docs/cli-examples.md | npm run docs:examples:smoke | packages/babysitter-sdk/scripts/smoke-cli.js | packages/babysitter-sdk/test-fixtures/cli/runs/smoke/ |
| Repo-published command references and fenced examples | npm run docs:snippets | scripts/docs-code-samples-check.cjs | artifacts/docs-qa/docs-code-samples-report.json |
| Markdown/style validation for published docs | npm run docs:lint | package.json#scripts.docs:lint | stdout/stderr from markdownlint-cli2 and docs-style-check.cjs |
| Deterministic SDK harness APIs referenced from docs | npm run test --workspace=@a5c-ai/babysitter-sdk | packages/babysitter-sdk/package.json#scripts.test | packages/babysitter-sdk/src/testing/__tests__/runHarness.test.ts, packages/babysitter-sdk/src/testing/__tests__/parallelHarness.test.ts, packages/babysitter-sdk/src/runtime/__tests__/deterministicHarness.test.ts |
| Generated CLI/docs traceability inventory | npm run docs:examples:generate | scripts/generate-cli-examples-artifacts.cjs | docs/generated/cli-examples-verification.{md,json} |
Script Inventory
Root Scripts
| Script | Command |
|---|---|
| build:runtime | npm run build:runtime:genty-platform-deps && npm run build --workspace=@a5c-ai/genty-platform |
| docs:prepare | node ./scripts/generate-process-library-doc-artifacts.cjs && node ./scripts/generate-cli-examples-artifacts.cjs && node ./scripts/ensure-webpackbar-patch.cjs |
| docs:examples:generate | node ./scripts/generate-cli-examples-artifacts.cjs |
| docs:examples:smoke | npm run smoke:cli --workspace=@a5c-ai/babysitter-sdk |
| docs:examples:verify | npm run build --workspace=@a5c-ai/babysitter-sdk && npm run docs:prepare && npm run docs:examples:smoke && npm run docs:qa |
| docs:lint | npm run docs:lint:markdown && npm run docs:lint:style |
| docs:snippets | node ./scripts/docs-code-samples-check.cjs |
| docs:qa | npm run docs:lint && npm run docs:snippets && npm run docs:links && npm run docs:freshness |
SDK Scripts
| Script | Command |
|---|---|
| build | tsc --build tsconfig.json && node scripts/copy-template-assets.cjs |
| test | vitest run |
| smoke:cli | node scripts/smoke-cli.js --runs-dir packages/babysitter-sdk/test-fixtures/cli/runs/smoke |
Smoke Harness Contract
- Command:
npm run smoke:cli --workspace=@a5c-ai/babysitter-sdk - Implementation:
packages/babysitter-sdk/scripts/smoke-cli.js - Default runs directory:
packages/babysitter-sdk/test-fixtures/cli/runs/smoke - Supported flags:
--runs-dir,--cli,--keep
Notes
- The current CLI smoke harness does not publish a --record baseline surface.
- The current repo does not define docs:testing-readme or docs:snippets:* package-local scripts.
- The CLI/example verification path only requires the SDK build; it does not depend on the broader build:runtime umbrella command.
- Use docs:examples:verify for the end-to-end repo workflow that combines docs generation, smoke verification, and docs QA.
Source Files
package.jsonpackages/babysitter-sdk/package.jsonpackages/babysitter-sdk/scripts/smoke-cli.jsscripts/docs-code-samples-check.cjsscripts/docs-style-check.cjsscripts/docs-freshness-report.cjsdocs/cli-examples.mdpackages/babysitter-sdk/src/testing/README.mdlibrary/reference/sdk.md