wehub-resource-sync
426e9eeabd
Voice Workbench / headless workbench (mocked backends) (push) Has been cancelled
Voice Workbench / real acoustic lane (nightly, provisioned only) (push) Has been cancelled
ci / test (push) Has been cancelled
ci / lint-and-format (push) Has been cancelled
ci / build (push) Has been cancelled
ci / dev-startup (push) Has been cancelled
gitleaks / gitleaks (push) Has been cancelled
Markdown Links / Relative Markdown Links (push) Has been cancelled
Quality (Extended) / Homepage Build (PR smoke) (push) Has been cancelled
Quality (Extended) / Comment-only diff guard (push) Has been cancelled
Quality (Extended) / Format + Type Safety Ratchet (push) Has been cancelled
Quality (Extended) / Develop Gate (secret scan + UI determinism) (push) Has been cancelled
Quality (Extended) / Develop Gate (lint) (push) Has been cancelled
Chat shell gestures / Chat shell gesture + parity e2e (push) Has been cancelled
Cloud Gateway Discord / Test (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx @biomejs/biome check packages/lifeops-bench/src, benchmark-lint) (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx vitest run --config packages/lifeops-bench/vitest.config.ts --root packages/lifeops-bench --passWithNoTests, benchmark-tests) (push) Has been cancelled
Build Agent Image / build-and-push (push) Has been cancelled
Dev Smoke / bun run dev onboarding chat (push) Has been cancelled
Dev Smoke / Vite HMR dependency-level smoke (push) Has been cancelled
Electrobun Submodule Guard / electrobun gitlink is fetchable (push) Has been cancelled
Publish @elizaos/example-code / check_npm (push) Has been cancelled
Publish @elizaos/example-code / publish_npm (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / verify_version (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / publish_npm (push) Has been cancelled
Sandbox Live Smoke / Sandbox live smoke (push) Has been cancelled
Snap Build & Test / Build Snap (amd64) (push) Has been cancelled
Snap Build & Test / Build Snap (arm64) (push) Has been cancelled
Test Packaging / elizaos CLI global-install smoke (node + bun) (push) Has been cancelled
Cloud Gateway Webhook / Test (push) Has been cancelled
Cloud Tests / lint-and-types (push) Has been cancelled
Cloud Tests / unit-tests (push) Has been cancelled
Cloud Tests / integration-tests (push) Has been cancelled
Cloud Tests / e2e-tests (push) Has been cancelled
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
Deploy Apps Worker (Product 2) / Determine environment (push) Has been cancelled
Deploy Apps Worker (Product 2) / Deploy apps worker to apps-control host (${{ needs.determine-env.outputs.environment }}) (push) Has been cancelled
Deploy Eliza Provisioning Worker / Determine environment (push) Has been cancelled
Deploy Eliza Provisioning Worker / Deploy worker to Hetzner host (${{ needs.determine-env.outputs.environment }} @ ${{ needs.determine-env.outputs.deployment_sha }}) (push) Has been cancelled
Dev Smoke / Classify changed paths (push) Has been cancelled
supply-chain / sbom (push) Has been cancelled
supply-chain / vulnerability-scan (push) Has been cancelled
Build, Push & Deploy to Phala Cloud / build-and-push (push) Has been cancelled
Test Packaging / Validate Packaging Configs (push) Has been cancelled
Test Packaging / Build & Test PyPI Package (push) Has been cancelled
Test Packaging / PyPI on Python ${{ matrix.python }} (push) Has been cancelled
Test Packaging / Pack & Test JS Tarballs (push) Has been cancelled
UI Fixture E2E / ui-fixture-e2e (push) Has been cancelled
UI Fixture E2E / fixture-e2e (push) Has been cancelled
UI Story Gate / story-gate (push) Has been cancelled
vault-ci / test (macos-latest) (push) Has been cancelled
vault-ci / test (ubuntu-latest) (push) Has been cancelled
vault-ci / test (windows-latest) (push) Has been cancelled
vault-ci / app-core wiring tests (push) Has been cancelled
verify-patches / verify patches/CHECKSUMS.sha256 (push) Has been cancelled
Voice Benchmark Smoke / voice-emotion fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voiceagentbench fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench-quality unit smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench TypeScript unit (no audio) (push) Has been cancelled
Voice Benchmark Smoke / voice bench smoke summary (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/app-core test bun run --cwd packages/elizaos test bun run --cwd packages/cloud/shared test], app-and-cli) (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/scenario-runner test bun run --cwd packages/vault test bun run --cwd packages/security test bun run --cwd plugins/plugin-coding-tools test], framework-packages) (push) Has been cancelled
Windows CI / windows ([bun run --cwd plugins/plugin-elizacloud test bun run --cwd plugins/plugin-discord test bun run --cwd plugins/plugin-anthropic test bun run --cwd plugins/plugin-openai test bun run --cwd plugins/plugin-app-control test bun run --cwd plugins/pl… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run build --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/agent --concurrency=4 node packages/scripts/run-bash-linux-only.mjs scripts/verify-riscv64-buildpaths.sh node packages/scripts/run… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run typecheck --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/cloud-shared --concurrency=4 bun run --cwd packages/core test bun run --cwd packages/shared test], core-runtime, 75) (push) Has been cancelled
261 lines
8.4 KiB
HTML
261 lines
8.4 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>elizaOS Examples Setup Guide</title>
|
|
<style>
|
|
:root {
|
|
color-scheme: light dark;
|
|
font-family:
|
|
Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
|
|
"Segoe UI", sans-serif;
|
|
line-height: 1.5;
|
|
}
|
|
body {
|
|
margin: 0;
|
|
color: #1f2937;
|
|
background: #f7f7f5;
|
|
}
|
|
main {
|
|
max-width: 980px;
|
|
margin: 0 auto;
|
|
padding: 40px 24px 64px;
|
|
}
|
|
h1,
|
|
h2,
|
|
h3 {
|
|
color: #111827;
|
|
line-height: 1.15;
|
|
}
|
|
h1 {
|
|
margin: 0 0 8px;
|
|
font-size: 34px;
|
|
}
|
|
h2 {
|
|
margin-top: 36px;
|
|
padding-top: 22px;
|
|
border-top: 1px solid #d8d8d2;
|
|
}
|
|
a {
|
|
color: #075985;
|
|
}
|
|
code,
|
|
pre {
|
|
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
|
|
}
|
|
pre {
|
|
overflow: auto;
|
|
padding: 14px 16px;
|
|
border: 1px solid #d8d8d2;
|
|
border-radius: 8px;
|
|
background: #ffffff;
|
|
}
|
|
table {
|
|
width: 100%;
|
|
border-collapse: collapse;
|
|
margin: 16px 0 24px;
|
|
background: #ffffff;
|
|
}
|
|
th,
|
|
td {
|
|
border: 1px solid #d8d8d2;
|
|
padding: 10px 12px;
|
|
text-align: left;
|
|
vertical-align: top;
|
|
}
|
|
th {
|
|
background: #ecece7;
|
|
}
|
|
.note {
|
|
padding: 12px 14px;
|
|
border-left: 4px solid #0f766e;
|
|
background: #eef8f6;
|
|
}
|
|
@media (prefers-color-scheme: dark) {
|
|
body {
|
|
color: #e5e7eb;
|
|
background: #111827;
|
|
}
|
|
h1,
|
|
h2,
|
|
h3 {
|
|
color: #f9fafb;
|
|
}
|
|
a {
|
|
color: #7dd3fc;
|
|
}
|
|
pre,
|
|
table {
|
|
background: #1f2937;
|
|
}
|
|
th {
|
|
background: #374151;
|
|
}
|
|
th,
|
|
td,
|
|
pre,
|
|
h2 {
|
|
border-color: #4b5563;
|
|
}
|
|
.note {
|
|
color: #d1fae5;
|
|
background: #064e3b;
|
|
}
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<h1>elizaOS Examples Setup Guide</h1>
|
|
<p>
|
|
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.
|
|
</p>
|
|
|
|
<div class="note">
|
|
Run local verification from the repository root with
|
|
<code>bun install</code>, then each example's
|
|
<code>bun run typecheck</code>, <code>bun run test</code>, and
|
|
<code>bun run build</code> scripts where present. Live integrations
|
|
should start in dry-run or test projects.
|
|
</div>
|
|
|
|
<h2>Minecraft</h2>
|
|
<p>
|
|
Minecraft automation currently lives in
|
|
<code>plugins/plugin-minecraft</code> and uses a local Mineflayer bridge
|
|
server. There is no separate <code>packages/examples/minecraft</code>
|
|
app in this worktree.
|
|
</p>
|
|
<ol>
|
|
<li>
|
|
Install Java and run a local Minecraft Java server, or use a test
|
|
server you control. Mojang's server setup docs:
|
|
<a href="https://www.minecraft.net/en-us/download/server">
|
|
Minecraft Java Server
|
|
</a>.
|
|
</li>
|
|
<li>
|
|
Review Mineflayer setup and supported versions:
|
|
<a href="https://github.com/PrismarineJS/mineflayer">Mineflayer</a>.
|
|
</li>
|
|
<li>
|
|
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.
|
|
</li>
|
|
</ol>
|
|
<pre><code>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</code></pre>
|
|
|
|
<h2>Other Human-Gated Examples</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Example</th>
|
|
<th>Setup links</th>
|
|
<th>Local command</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>AWS</td>
|
|
<td>
|
|
<a href="https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html">AWS CLI</a>,
|
|
<a href="https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html">AWS SAM CLI</a>
|
|
</td>
|
|
<td><code>cd packages/examples/aws && bun run test</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>GCP</td>
|
|
<td>
|
|
<a href="https://docs.cloud.google.com/sdk/docs/install-sdk">Google Cloud CLI</a>,
|
|
<a href="https://docs.cloud.google.com/run/docs/quickstarts/build-and-deploy/deploy-nodejs-service">Cloud Run Node.js</a>
|
|
</td>
|
|
<td><code>cd packages/examples/gcp && bun run build</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Cloudflare</td>
|
|
<td>
|
|
<a href="https://developers.cloudflare.com/workers/wrangler/install-and-update/">Wrangler</a>,
|
|
<a href="https://developers.cloudflare.com/workers/configuration/secrets/">Worker secrets</a>
|
|
</td>
|
|
<td><code>cd packages/examples/cloudflare && bun run dev</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Convex</td>
|
|
<td>
|
|
<a href="https://docs.convex.dev/tutorial">Convex quickstart</a>,
|
|
<a href="https://docs.convex.dev/production/environment-variables/">Convex env vars</a>
|
|
</td>
|
|
<td><code>cd packages/examples/convex && convex dev</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Supabase</td>
|
|
<td>
|
|
<a href="https://supabase.com/docs/guides/local-development/cli/getting-started">Supabase CLI</a>,
|
|
<a href="https://supabase.com/docs/guides/functions/secrets">Edge Function secrets</a>
|
|
</td>
|
|
<td><code>cd packages/examples/supabase && supabase start</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Vercel</td>
|
|
<td>
|
|
<a href="https://vercel.com/docs/cli">Vercel CLI</a>,
|
|
<a href="https://vercel.com/docs/environment-variables">Vercel env vars</a>
|
|
</td>
|
|
<td><code>cd packages/examples/vercel && bun run dev</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Social bots</td>
|
|
<td>
|
|
<a href="https://docs.discord.com/developers/quick-start/getting-started">Discord apps</a>,
|
|
<a href="https://core.telegram.org/bots/tutorial">Telegram bots</a>,
|
|
<a href="https://docs.bsky.app/docs/get-started">Bluesky API</a>,
|
|
<a href="https://docs.neynar.com/">Neynar/Farcaster</a>
|
|
</td>
|
|
<td>Use each package README and dry-run flags first.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Smartglasses</td>
|
|
<td>
|
|
<a href="https://hub.evenrealities.com/docs/getting-started/installation">Even Hub setup</a>,
|
|
<a href="https://github.com/abandonware/noble">Noble BLE</a>
|
|
</td>
|
|
<td><code>cd packages/examples/smartglasses && bun run test</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Wallet/trading</td>
|
|
<td>
|
|
<a href="https://solana.com/docs/intro/installation">Solana CLI</a>,
|
|
<a href="https://docs.birdeye.so/">Birdeye API</a>,
|
|
<a href="https://docs.li.fi/introduction/introduction">LI.FI</a>
|
|
</td>
|
|
<td>Use paper trading and isolated test wallets first.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h2>Model Keys</h2>
|
|
<p>
|
|
Most server examples need one model provider key. Common options are
|
|
<a href="https://developers.openai.com/api/docs/quickstart#create-and-export-an-api-key">OpenAI</a>,
|
|
<a href="https://platform.claude.com/settings/keys">Anthropic</a>,
|
|
<a href="https://aistudio.google.com/app/apikey">Google GenAI</a>,
|
|
<a href="https://console.groq.com/keys">Groq</a>,
|
|
<a href="https://docs.x.ai/developers/quickstart">xAI</a>, and
|
|
<a href="https://openrouter.ai/settings/keys">OpenRouter</a>.
|
|
</p>
|
|
</main>
|
|
</body>
|
|
</html>
|