wehub-resource-sync
426e9eeabd
Benchmark Bridge Tests / benchmark (bunx @biomejs/biome check packages/lifeops-bench/src, benchmark-lint) (push) Waiting to run
Benchmark Bridge Tests / benchmark (bunx vitest run --config packages/lifeops-bench/vitest.config.ts --root packages/lifeops-bench --passWithNoTests, benchmark-tests) (push) Waiting to run
Build Agent Image / build-and-push (push) Waiting to run
Chat shell gestures / Chat shell gesture + parity e2e (push) Waiting to run
ci / test (push) Waiting to run
ci / lint-and-format (push) Waiting to run
ci / build (push) Waiting to run
ci / dev-startup (push) Waiting to run
Cloud Gateway Discord / Test (push) Waiting to run
Cloud Gateway Webhook / Test (push) Waiting to run
Cloud Tests / lint-and-types (push) Waiting to run
Cloud Tests / unit-tests (push) Waiting to run
Cloud Tests / integration-tests (push) Waiting to run
Cloud Tests / e2e-tests (push) Blocked by required conditions
CodeQL Advanced / Analyze (javascript-typescript) (push) Waiting to run
Deploy Apps Worker (Product 2) / Determine environment (push) Waiting to run
Deploy Apps Worker (Product 2) / Deploy apps worker to apps-control host (${{ needs.determine-env.outputs.environment }}) (push) Blocked by required conditions
Deploy Eliza Provisioning Worker / Determine environment (push) Waiting to run
Deploy Eliza Provisioning Worker / Deploy worker to Hetzner host (${{ needs.determine-env.outputs.environment }} @ ${{ needs.determine-env.outputs.deployment_sha }}) (push) Blocked by required conditions
Dev Smoke / Classify changed paths (push) Waiting to run
Dev Smoke / bun run dev onboarding chat (push) Blocked by required conditions
Dev Smoke / Vite HMR dependency-level smoke (push) Blocked by required conditions
Electrobun Submodule Guard / electrobun gitlink is fetchable (push) Waiting to run
gitleaks / gitleaks (push) Waiting to run
Markdown Links / Relative Markdown Links (push) Waiting to run
Publish @elizaos/example-code / check_npm (push) Waiting to run
Publish @elizaos/example-code / publish_npm (push) Blocked by required conditions
Publish @elizaos/plugin-elizacloud / verify_version (push) Waiting to run
Publish @elizaos/plugin-elizacloud / publish_npm (push) Blocked by required conditions
Quality (Extended) / Homepage Build (PR smoke) (push) Waiting to run
Quality (Extended) / Comment-only diff guard (push) Waiting to run
Quality (Extended) / Format + Type Safety Ratchet (push) Waiting to run
Quality (Extended) / Develop Gate (secret scan + UI determinism) (push) Waiting to run
Quality (Extended) / Develop Gate (lint) (push) Waiting to run
Sandbox Live Smoke / Sandbox live smoke (push) Waiting to run
Snap Build & Test / Build Snap (amd64) (push) Waiting to run
Snap Build & Test / Build Snap (arm64) (push) Waiting to run
supply-chain / sbom (push) Waiting to run
supply-chain / vulnerability-scan (push) Waiting to run
Build, Push & Deploy to Phala Cloud / build-and-push (push) Waiting to run
Test Packaging / Validate Packaging Configs (push) Waiting to run
Test Packaging / PyPI on Python ${{ matrix.python }} (push) Waiting to run
Test Packaging / Pack & Test JS Tarballs (push) Waiting to run
Test Packaging / elizaos CLI global-install smoke (node + bun) (push) Waiting to run
UI Fixture E2E / ui-fixture-e2e (push) Waiting to run
UI Fixture E2E / fixture-e2e (push) Waiting to run
UI Story Gate / story-gate (push) Waiting to run
vault-ci / test (macos-latest) (push) Waiting to run
vault-ci / test (ubuntu-latest) (push) Waiting to run
vault-ci / test (windows-latest) (push) Waiting to run
vault-ci / app-core wiring tests (push) Waiting to run
verify-patches / verify patches/CHECKSUMS.sha256 (push) Waiting to run
Voice Benchmark Smoke / voice-emotion fixture smoke (push) Waiting to run
Voice Benchmark Smoke / voiceagentbench fixture smoke (push) Waiting to run
Voice Benchmark Smoke / voicebench-quality unit smoke (push) Waiting to run
Voice Benchmark Smoke / voicebench TypeScript unit (no audio) (push) Waiting to run
Voice Benchmark Smoke / voice bench smoke summary (push) Blocked by required conditions
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) Waiting to run
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) Waiting to run
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) Waiting to run
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) Waiting to run
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) Waiting to run
Test Packaging / Build & Test PyPI Package (push) Waiting to run
Voice Workbench / headless workbench (mocked backends) (push) Has been cancelled
Voice Workbench / real acoustic lane (nightly, provisioned only) (push) Has been cancelled
151 lines
8.1 KiB
Markdown
151 lines
8.1 KiB
Markdown
<div align="center">
|
|
<img src="packages/shared/assets/banners/elizaos_banner.svg" alt="elizaOS" width="100%" />
|
|
<h1>elizaOS</h1>
|
|
<p><strong>Your agentic operating system.</strong></p>
|
|
<p>
|
|
<a href="https://eliza.app">Homepage</a> ·
|
|
<a href="https://app.elizacloud.ai">Web app</a> ·
|
|
<a href="https://os.elizacloud.ai">Install the OS</a> ·
|
|
<a href="https://docs.elizaos.ai/">Docs</a> ·
|
|
<a href="https://plugins.elizacloud.ai">App catalog</a>
|
|
</p>
|
|
</div>
|
|
|
|
## What is this?
|
|
|
|
elizaOS is an open-source, local-first operating system for AI agents. Two parts:
|
|
|
|
- **Eliza** — the app. An AI assistant for **desktop, mobile, and web**: chat, voice, your messaging accounts, a personal-assistant brain, a non-custodial wallet, browser automation, and on-device models.
|
|
- **elizaOS** — the runtime and the OS underneath it. The same runtime can take over the whole machine — boot a **Linux** desktop or run on **Android** as the system assistant.
|
|
|
|
The agent, your data, and the models all run on your device. [Eliza Cloud](#eliza-cloud-optional) is optional — add it for hosted inference, sync, and deploys.
|
|
|
|
## Get Eliza
|
|
|
|
| Platform | How |
|
|
| ------------------------------------- | ------------------------------------------------------------------- |
|
|
| **Web** | Open [app.elizacloud.ai](https://app.elizacloud.ai) |
|
|
| **Desktop** — macOS · Windows · Linux | Download from [GitHub Releases](https://github.com/elizaOS/eliza/releases) |
|
|
| **iOS · Android** | App Store · Play · sideload |
|
|
|
|
Run from source:
|
|
|
|
```bash
|
|
git clone --filter=blob:none https://github.com/elizaos/eliza.git
|
|
cd eliza
|
|
bun install
|
|
bun run dev # API + the Eliza app UI
|
|
```
|
|
|
|
To run a whole device as elizaOS instead, see [elizaOS — the operating system](#elizaos-the-operating-system).
|
|
|
|
## What Eliza does
|
|
|
|
The app ships with:
|
|
|
|
- 💬 **Chat** — one inbox for your agent and your accounts (iMessage, Discord, Telegram, WhatsApp, Slack, Farcaster, X).
|
|
- 🎙️ **Voice** — hands-free voice with on-device transcription and natural speech.
|
|
- 📇 **Phone · Messages · Contacts** — telephony and SMS surfaces (native on Android).
|
|
- 🧠 **Personal assistant** — calendar, reminders, inbox triage, tasks, daily brief, and owner-approved actions.
|
|
- 🌐 **Browser & computer use** — the agent drives a real browser and desktop.
|
|
- 👛 **Wallet** — non-custodial EVM + Solana: transfers, swaps, bridges, LP. Every spend needs your OK.
|
|
- 📄 **Documents** — ask questions over your files (RAG).
|
|
- 📷 **Camera & vision** — capture and reason over images.
|
|
- ⚙️ **Automations** — schedule recurring work; pick models and routing.
|
|
|
|
## Private by default
|
|
|
|
Eliza can run the whole pipeline on your device via **Eliza-1**, the on-device model family (Gemma-4):
|
|
|
|
- **Text** generation and embeddings, from ~2B (phone) to ~27B (desktop).
|
|
- **Voice** — local speech-to-text and text-to-speech; audio never leaves the device.
|
|
- **Vision & images** — on-device description and generation.
|
|
|
|
Pick a model in **Settings → Model Routing** and it downloads and pins; from then on it works with no network.
|
|
|
|
## Apps on elizaOS
|
|
|
|
elizaOS runs **apps**, not just an agent. An app is a plugin that adds a surface inside Eliza; the runtime installs, launches, and tracks it like real software, and it survives restarts.
|
|
|
|
- **Browse & install** — catalog at [plugins.elizacloud.ai](https://plugins.elizacloud.ai); curated entries in [`packages/registry`](packages/registry), plus any npm package tagged `elizaos`.
|
|
- **First-party apps** — [`plugin-browser`](plugins/plugin-browser), [`plugin-documents`](plugins/plugin-documents), [`plugin-phone`](plugins/plugin-phone), [`plugin-task-coordinator`](plugins/plugin-task-coordinator).
|
|
- **Earn** — apps deployed through Eliza Cloud can be metered and monetized.
|
|
|
|
## elizaOS — the operating system
|
|
|
|
[`packages/os`](packages/os) is the real, bootable distribution. Downloads and hardware are at **[os.elizacloud.ai](https://os.elizacloud.ai)**.
|
|
|
|
- **Linux** ([`packages/os/linux`](packages/os/linux)) — boots a full desktop with Eliza built in from a USB stick. amd64 · arm64 · riscv64.
|
|
- **Android** ([`packages/os/android`](packages/os/android)) — Eliza is the system launcher and assistant, on Pixel-class devices.
|
|
|
|
The OS is bootable today; full device certification and production update channels are in progress — see the per-target READMEs for status.
|
|
|
|
## Eliza Cloud (optional)
|
|
|
|
Optional managed backend for going beyond one device. Never required — local-only is first-class. It adds:
|
|
|
|
- **Auth** — accounts and sign-in (OAuth/SIWS).
|
|
- **Hosted inference** — model routing across providers, billed per use.
|
|
- **Deploy** — push an agent or app to a container with its own domain.
|
|
- **Sync & bridge** — state across devices; drive a local agent from the cloud dashboard.
|
|
- **Monetization** — metering and creator earnings for published apps, agents, and MCPs.
|
|
|
|
## Build on elizaOS
|
|
|
|
The runtime is open source and yours to extend. Start with the CLI:
|
|
|
|
```bash
|
|
bun add -g elizaos@beta
|
|
elizaos create my-app --template project # a deployable app workspace
|
|
elizaos create my-plugin -t plugin # a runtime plugin (action/provider/service)
|
|
```
|
|
|
|
The runtime is **model-agnostic** (OpenAI, Anthropic, Gemini, Grok, Llama, local Eliza-1, …) and extended through a small set of primitives:
|
|
|
|
- **`@elizaos/core`** ([packages/core](packages/core)) — the agent loop, plugin model, and message/memory/state primitives.
|
|
- **`@elizaos/agent`** ([packages/agent](packages/agent)) — `AgentRuntime`, the plugin loader, and the default plugin map.
|
|
- **`@elizaos/app-core`** ([packages/app-core](packages/app-core)) — the API + dashboard host that runs agents.
|
|
- **`elizaos`** ([packages/elizaos](packages/elizaos)) — the CLI: `create`, `info`, `upgrade`.
|
|
|
|
A **plugin** exports a `Plugin` that registers **actions** (what the agent does), **providers** (prompt context), **services** (long-lived singletons), and **evaluators** (post-response work). Import `@elizaos/core` directly to use the runtime with no CLI or UI — see [`packages/examples`](packages/examples) and the evaluation suites in [`packages/benchmarks`](packages/benchmarks). Full guides: **[docs.elizaos.ai](https://docs.elizaos.ai/)**.
|
|
|
|
## Working in the monorepo
|
|
|
|
```bash
|
|
bun install # workspace install
|
|
bun run install:light # skip the large artifact download when disk or time is tight
|
|
bun run dev # API + Vite UI for apps/app
|
|
bun run build # turbo build across the workspace
|
|
bun run test # full test suite
|
|
bun run cloud:mock # boot the local cloud backend stack with mocks
|
|
```
|
|
|
|
The repo is self-contained — runtime, CLI, dashboard, native OS forks, cloud backend, and first-party plugins all live here. Every package carries its own `README.md`; read it before working inside. Tree map: [`AGENTS.md`](AGENTS.md).
|
|
|
|
## Contributing
|
|
|
|
Contributions welcome. Open an issue before sending a non-trivial PR. Before
|
|
opening a PR, read [CONTRIBUTING.md](CONTRIBUTING.md) and the evidence standard
|
|
in [AGENTS.md](AGENTS.md); frontend-testable changes need screenshots (JPG), an
|
|
MP4 video walkthrough, logs, and any relevant real-LLM trajectories attached
|
|
inline in the PR itself. Agents and maintainers working from a GitHub Project
|
|
board use the coordination workflow in [CONTRIBUTING.md](CONTRIBUTING.md) before
|
|
claiming kanban work. Active MVP work is coordinated on the
|
|
[LifeOps Personal Assistant MVP board](https://github.com/orgs/elizaOS/projects/15)
|
|
and in [Discussions](https://github.com/elizaOS/eliza/discussions); in-flight
|
|
design docs live in
|
|
[`packages/docs/ongoing-development/`](packages/docs/ongoing-development/README.md).
|
|
|
|
- [Bug Report](.github/ISSUE_TEMPLATE/bug_report.md)
|
|
- [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md)
|
|
- [Agent Work Item](.github/ISSUE_TEMPLATE/agent_work_item.md)
|
|
- [Security Policy](SECURITY.md)
|
|
- [Windows Setup](WINDOWS.md)
|
|
|
|
To report a security vulnerability, follow [SECURITY.md](SECURITY.md); do not
|
|
open a public issue.
|
|
|
|
## License
|
|
|
|
MIT — see [LICENSE](LICENSE).
|