Back to Eliza

Examples Validation Report

packages/examples/VALIDATION.md

2.0.38.1 KB
Original Source

Examples Validation Report

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.

Local Verification Commands

Run these from the repository root after bun install:

bash
# 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

Current Local Evidence

The local examples sweep has been run in this worktree with these outcomes:

ScopeEvidence
Dependency installbun install completed.
Package typechecksnode packages/examples/scripts/verify-examples.mjs --mode typecheck completed with 0 failures.
Package testsnode 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 buildsnode 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 rechecka2a, bluesky, mcp, roblox, smartglasses, trader, twitter-xai, cloud/clone-ur-crush, cloud/edad, and form passed targeted reruns after the last fixes.
Static docsnode 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 Matrix

ExampleLocal verificationLive / manual verification still required
_plugintypecheck, test, buildOptional manual Cypress flow via test:e2e:manual.
a2atypecheck, test, buildOPENAI_API_KEY for model-backed mode.
agent-consoletypecheckBrowser session plus one provider key to inspect live SSE telemetry.
app/capacitorParent skip scripts plus backend/frontend package checksNative Capacitor device/simulator testing and provider keys.
app/capacitor/backendtypecheck, test, buildProvider key and device/simulator flow through the Capacitor shell.
app/capacitor/frontendtypecheck, buildBrowser and native WebView smoke test against a configured backend.
app/electronParent skip scripts plus backend/frontend package checksDesktop Electron launch and provider-key chat flow.
app/electron/backendtypecheck, test, buildProvider-key chat flow from the packaged Electron shell.
app/electron/frontendtypecheck, buildRenderer smoke test in Electron and browser dev-server mode.
autonomoustypecheck, buildOptional local model and shell sandbox configuration.
avatartypecheck, buildBrowser microphone/audio flow, selected model key, optional ElevenLabs key.
awstypecheck, test, buildAWS account, SAM deployment, and Lambda invocation with OPENAI_API_KEY.
blueskytypecheck, test, buildLIVE_TEST=true with Bluesky credentials and dry-run/posting flags.
browser-extensionParent typecheck skip and documented Chrome/Safari package checksLoad unpacked Chrome extension; Safari requires Xcode signing/install.
browser-extension/chrometypecheck, explicit build skipbuild:tsup only after resolving browser bundling of Node-only workspace deps; load unpacked for runtime validation.
browser-extension/safariTypecheck skip, scripted Safari build pathXcode and Safari extension signing.
chattypecheck, buildOne configured provider key for live chat.
cloud/clone-ur-crushtypecheck, test, buildLive Next.js flow with required model/image provider keys.
cloud/edadtypecheck, test, buildManual server launch with Eliza Cloud app ID, affiliate code, and signed-in user token.
cloudflaretypecheck, test, buildWrangler login, Worker secret, deployed or local Worker endpoint.
codetypecheck, test, buildProvider-key E2E flows for subagents/game generation.
convextypecheck, test, buildconvex dev or deployed Convex URL plus provider key in Convex env.
discordtypecheck, test, buildDiscord app credentials, bot install, provider key.
elizagotchitypecheck, buildBrowser gameplay smoke test.
farcastertypecheck, buildNeynar/Farcaster credentials; start with dry-run.
farcaster-miniapptypecheck, buildFarcaster mini app host plus wallet/provider integrations.
formtypecheck, test, build through shared chat entrypointManual run through shared chat entrypoint with one provider key.
game-of-lifetypecheck, test, buildTest runs a short non-interactive simulation.
gcptypecheck, buildGCP project, Cloud Run deployment, deployed test client URL.
htmlTypecheck/build skip scriptsBrowser smoke test from static server.
lp-managertypecheck, test, buildIsolated Solana/EVM wallets and RPCs for live liquidity paths.
mcptypecheck, test, buildOpenAI key or compatible endpoint for live MCP chat.
moltbooktypecheck, buildLLM_API_KEY; token only for write actions.
moltbook/bags-claimerTypecheck/build skip scriptsWallet/RPC setup for claim flow.
nexttypecheck, explicit build skipbuild:next for opt-in Next.js bundle verification; provider key for live chat.
reacttypecheck, buildBrowser smoke test.
rest-api/elysiatypecheck, buildStart server and run HTTP chat flow.
rest-api/expresstypecheck, buildStart server and run HTTP chat flow.
rest-api/honotypecheck, buildStart server and run HTTP chat flow.
robloxtypecheck, test, buildRoblox Studio place, Open Cloud key, tunnel/shared-secret bridge test.
smartglassestypecheck, testEven Realities simulator or BLE hardware evidence report.
supabaseStatic review; no package scriptsSupabase CLI/Deno function serve or deployment with anon key and OPENAI_API_KEY.
telegramtypecheck, buildTelegram bot token and provider key.
text-adventuretypecheck, buildOptional manual CLI playthrough.
tic-tac-toetypecheck, test, buildTest runs the non-interactive bench mode.
tradertypecheck, buildPaper-trading UI flow, then isolated-wallet live testing only when intended.
twitter-xaitypecheck, buildX/xAI credentials; start with TWITTER_DRY_RUN=true.
verceltypecheck, test, buildVercel project/env plus deployed or vercel dev API endpoint.

Not Yet Proven By Local Automation

These requirements cannot be honestly marked complete from local scripts alone:

  • External account deployments: AWS, GCP, Cloudflare, Convex, Supabase, Vercel.
  • Public/social posting flows: Bluesky, Discord, Farcaster, Telegram, Twitter/X.
  • Desktop or hardware flows: Roblox Studio, Safari/Xcode, Capacitor device builds, Electron app launch, Smartglasses BLE hardware.
  • Financial transaction flows: 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.