elizaOS Examples Setup Guide

Use this page for examples that need accounts, desktop apps, cloud CLIs, game servers, API keys, or hardware before the local test clients can run end to end.

Run local verification from the repository root with bun install, then each example's bun run typecheck, bun run test, and bun run build scripts where present. Live integrations should start in dry-run or test projects.

Minecraft

Minecraft automation currently lives in plugins/plugin-minecraft and uses a local Mineflayer bridge server. There is no separate packages/examples/minecraft app in this worktree.

  1. Install Java and run a local Minecraft Java server, or use a test server you control. Mojang's server setup docs: Minecraft Java Server .
  2. Review Mineflayer setup and supported versions: Mineflayer.
  3. For offline local testing, configure the server for offline auth and use a test username. For production servers, use proper online auth and a dedicated account. 
cd plugins/plugin-minecraft/mineflayer-server
bun install
export MC_SERVER_PORT=3457
export MC_HOST=127.0.0.1
export MC_PORT=25565
export MC_AUTH=offline
export MC_USERNAME=ElizaBot
bun run build
bun run start

Other Human-Gated Examples

Example Setup links Local command
AWS AWS CLI, AWS SAM CLI cd packages/examples/aws && bun run test
GCP Google Cloud CLI, Cloud Run Node.js cd packages/examples/gcp && bun run build
Cloudflare Wrangler, Worker secrets cd packages/examples/cloudflare && bun run dev
Convex Convex quickstart, Convex env vars cd packages/examples/convex && convex dev
Supabase Supabase CLI, Edge Function secrets cd packages/examples/supabase && supabase start
Vercel Vercel CLI, Vercel env vars cd packages/examples/vercel && bun run dev
Social bots Discord apps, Telegram bots, Bluesky API, Neynar/Farcaster Use each package README and dry-run flags first.
Smartglasses Even Hub setup, Noble BLE cd packages/examples/smartglasses && bun run test
Wallet/trading Solana CLI, Birdeye API, LI.FI Use paper trading and isolated test wallets first.

Model Keys

Most server examples need one model provider key. Common options are OpenAI, Anthropic, Google GenAI, Groq, xAI, and OpenRouter.