packages/examples/VALIDATION.md
Last updated: 2026-05-20
This report records the local verification state for every example under
packages/examples. It separates checks that can run locally from checks that
require external accounts, cloud projects, desktop apps, hardware, or credentials.
Run these from the repository root after bun install:
# List all example packages and scripts.
node packages/examples/scripts/verify-examples.mjs --mode list
# Check every example package has direct README coverage and top-level docs.
node packages/examples/scripts/verify-examples.mjs --mode docs
# Run local validation sweeps. These execute every package script of that kind.
node packages/examples/scripts/verify-examples.mjs --mode typecheck
node packages/examples/scripts/verify-examples.mjs --mode test
node packages/examples/scripts/verify-examples.mjs --mode build
# Optional full run with a machine-readable report.
node packages/examples/scripts/verify-examples.mjs --mode all --json packages/examples/verification-report.json
The local examples sweep has been run in this worktree with these outcomes:
| Scope | Evidence |
|---|---|
| Dependency install | bun install completed. |
| Package typechecks | node packages/examples/scripts/verify-examples.mjs --mode typecheck completed with 0 failures. |
| Package tests | node packages/examples/scripts/verify-examples.mjs --mode test completed after dependency/build repair. Live endpoint clients either passed locally or skipped cleanly when no live service URL/credential was configured. |
| Package builds | node packages/examples/scripts/verify-examples.mjs --mode build completed after targeted repairs. Human-gated or known bundler-limited examples use explicit skip scripts that explain the required opt-in command. |
| Final targeted recheck | a2a, bluesky, mcp, roblox, smartglasses, trader, twitter-xai, cloud/clone-ur-crush, cloud/edad, and form passed targeted reruns after the last fixes. |
| Static docs | node packages/examples/scripts/verify-examples.mjs --mode docs now checks each package README, every package row in this matrix, top-level links to setup-guide.html/VALIDATION.md, and setup guide sections for Roblox, Minecraft, cloud, social, hardware, and wallet examples. |
| Example | Local verification | Live / manual verification still required |
|---|---|---|
_plugin | typecheck, test, build | Optional manual Cypress flow via test:e2e:manual. |
a2a | typecheck, test, build | OPENAI_API_KEY for model-backed mode. |
agent-console | typecheck | Browser session plus one provider key to inspect live SSE telemetry. |
app/capacitor | Parent skip scripts plus backend/frontend package checks | Native Capacitor device/simulator testing and provider keys. |
app/capacitor/backend | typecheck, test, build | Provider key and device/simulator flow through the Capacitor shell. |
app/capacitor/frontend | typecheck, build | Browser and native WebView smoke test against a configured backend. |
app/electron | Parent skip scripts plus backend/frontend package checks | Desktop Electron launch and provider-key chat flow. |
app/electron/backend | typecheck, test, build | Provider-key chat flow from the packaged Electron shell. |
app/electron/frontend | typecheck, build | Renderer smoke test in Electron and browser dev-server mode. |
autonomous | typecheck, build | Optional local model and shell sandbox configuration. |
avatar | typecheck, build | Browser microphone/audio flow, selected model key, optional ElevenLabs key. |
aws | typecheck, test, build | AWS account, SAM deployment, and Lambda invocation with OPENAI_API_KEY. |
bluesky | typecheck, test, build | LIVE_TEST=true with Bluesky credentials and dry-run/posting flags. |
browser-extension | Parent typecheck skip and documented Chrome/Safari package checks | Load unpacked Chrome extension; Safari requires Xcode signing/install. |
browser-extension/chrome | typecheck, explicit build skip | build:tsup only after resolving browser bundling of Node-only workspace deps; load unpacked for runtime validation. |
browser-extension/safari | Typecheck skip, scripted Safari build path | Xcode and Safari extension signing. |
chat | typecheck, build | One configured provider key for live chat. |
cloud/clone-ur-crush | typecheck, test, build | Live Next.js flow with required model/image provider keys. |
cloud/edad | typecheck, test, build | Manual server launch with Eliza Cloud app ID, affiliate code, and signed-in user token. |
cloudflare | typecheck, test, build | Wrangler login, Worker secret, deployed or local Worker endpoint. |
code | typecheck, test, build | Provider-key E2E flows for subagents/game generation. |
convex | typecheck, test, build | convex dev or deployed Convex URL plus provider key in Convex env. |
discord | typecheck, test, build | Discord app credentials, bot install, provider key. |
elizagotchi | typecheck, build | Browser gameplay smoke test. |
farcaster | typecheck, build | Neynar/Farcaster credentials; start with dry-run. |
farcaster-miniapp | typecheck, build | Farcaster mini app host plus wallet/provider integrations. |
form | typecheck, test, build through shared chat entrypoint | Manual run through shared chat entrypoint with one provider key. |
game-of-life | typecheck, test, build | Test runs a short non-interactive simulation. |
gcp | typecheck, build | GCP project, Cloud Run deployment, deployed test client URL. |
html | Typecheck/build skip scripts | Browser smoke test from static server. |
lp-manager | typecheck, test, build | Isolated Solana/EVM wallets and RPCs for live liquidity paths. |
mcp | typecheck, test, build | OpenAI key or compatible endpoint for live MCP chat. |
moltbook | typecheck, build | LLM_API_KEY; token only for write actions. |
moltbook/bags-claimer | Typecheck/build skip scripts | Wallet/RPC setup for claim flow. |
next | typecheck, explicit build skip | build:next for opt-in Next.js bundle verification; provider key for live chat. |
react | typecheck, build | Browser smoke test. |
rest-api/elysia | typecheck, build | Start server and run HTTP chat flow. |
rest-api/express | typecheck, build | Start server and run HTTP chat flow. |
rest-api/hono | typecheck, build | Start server and run HTTP chat flow. |
roblox | typecheck, test, build | Roblox Studio place, Open Cloud key, tunnel/shared-secret bridge test. |
smartglasses | typecheck, test | Even Realities simulator or BLE hardware evidence report. |
supabase | Static review; no package scripts | Supabase CLI/Deno function serve or deployment with anon key and OPENAI_API_KEY. |
telegram | typecheck, build | Telegram bot token and provider key. |
text-adventure | typecheck, build | Optional manual CLI playthrough. |
tic-tac-toe | typecheck, test, build | Test runs the non-interactive bench mode. |
trader | typecheck, build | Paper-trading UI flow, then isolated-wallet live testing only when intended. |
twitter-xai | typecheck, build | X/xAI credentials; start with TWITTER_DRY_RUN=true. |
vercel | typecheck, test, build | Vercel project/env plus deployed or vercel dev API endpoint. |
These requirements cannot be honestly marked complete from local scripts alone:
trader, lp-manager, and wallet-enabled
Farcaster mini app paths.Use setup-guide.html for the account setup links and keep dry-run or paper
trading modes enabled until the target account, project, or wallet is verified.