elizaOS

<!-- WEHUB_ZH_README -->
> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。  
> [English](./README.en.md) · [原始项目](https://github.com/elizaOS/eliza) · [上游 README](https://github.com/elizaOS/eliza/blob/HEAD/README.md)  
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

<div align="center">
  <img src="packages/shared/assets/banners/elizaos_banner.svg" alt="elizaOS" width="100%" />
  <h1>elizaOS</h1>
  <p><strong>你的智能体操作系统。</strong></p>
  <p>
    <a href="https://eliza.app">首页</a> ·
    <a href="https://app.elizacloud.ai">Web 应用</a> ·
    <a href="https://os.elizacloud.ai">安装 OS</a> ·
    <a href="https://docs.elizaos.ai/">文档</a> ·
    <a href="https://plugins.elizacloud.ai">应用目录</a>
  </p>
</div>

## 这是什么？

elizaOS 是一款开源、本地优先（local-first）的 AI 智能体操作系统。由两部分组成：

- **Eliza** — 应用。面向**桌面、移动端和 Web** 的 AI 助手：聊天、语音、你的消息账号、个人助理大脑、非托管钱包、浏览器自动化，以及端侧模型。
- **elizaOS** — 底层运行时与操作系统。同一套运行时能够接管整台设备 —— 启动 **Linux** 桌面，或在 **Android** 上作为系统助手运行。

智能体、你的数据和模型都在你的设备上运行。[Eliza Cloud](#eliza-cloud-optional) 为可选 —— 可添加托管推理、同步与部署能力。

## 获取 Eliza

| 平台                              | 方式                                                                 |
| ------------------------------------- | ------------------------------------------------------------------- |
| **Web**                               | 打开 [app.elizacloud.ai](https://app.elizacloud.ai)                 |
| **Desktop** — macOS · Windows · Linux | 从 [GitHub Releases](https://github.com/elizaOS/eliza/releases) 下载 |
| **iOS · Android**                     | App Store · Play · 侧载（sideload）                                         |

从源码运行：

```bash
git clone --filter=blob:none https://github.com/elizaos/eliza.git
cd eliza
bun install
bun run dev          # API + the Eliza app UI
```

若要将整台设备作为 elizaOS 运行，请参阅 [elizaOS — 操作系统](#elizaos-the-operating-system)。

## Eliza 能做什么

应用内置：

- 💬 **Chat** — 智能体与各账号的统一收件箱（iMessage、Discord、Telegram、WhatsApp、Slack、Farcaster、X）。
- 🎙️ **Voice** — 免提语音，端侧转写与自然语音合成。
- 📇 **Phone · Messages · Contacts** — 电话与短信界面（Android 原生）。
- 🧠 **Personal assistant** — 日历、提醒、收件箱分拣、任务、每日简报，以及经所有者批准的操作。
- 🌐 **Browser & computer use** — 智能体驱动真实浏览器与桌面。
- 👛 **Wallet** — 非托管 EVM + Solana：转账、兑换、跨链桥、LP。每笔支出均需你确认。
- 📄 **Documents** — 针对文件提问（RAG）。
- 📷 **Camera & vision** — 拍摄图像并进行推理。
- ⚙️ **Automations** — 安排周期性任务；选择模型与路由。

## 默认私密

Eliza 可通过端侧模型家族 **Eliza-1**（Gemma-4）在设备上运行完整流水线：

- **Text** — 文本生成与嵌入，规模约 2B（手机）至约 27B（桌面）。
- **Voice** — 本地语音转文字与文字转语音；音频永不离开设备。
- **Vision & images** — 端侧描述与生成。

在 **Settings → Model Routing**（设置 → 模型路由）中选择模型后会下载并固定；此后无需网络即可使用。

## elizaOS 上的应用

elizaOS 运行的是**应用**，而不仅是智能体。应用是一种插件，会在 Eliza 内新增界面；运行时像真实软件一样安装、启动并跟踪，重启后依然保留。

- **Browse & install** — 目录见 [plugins.elizacloud.ai](https://plugins.elizacloud.ai);；[`packages/registry`](packages/registry) 中的精选条目，以及任何标记为 `elizaos` 的 npm 包。
- **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** — 通过 Eliza Cloud 部署的应用可按量计费并变现。

## elizaOS — 操作系统

[`packages/os`](packages/os) 是真正的可启动发行版。下载与硬件信息见 **[os.elizacloud.ai](https://os.elizacloud.ai)**.

- **Linux**（[`packages/os/linux`](packages/os/linux)）— 从 U 盘启动内置 Eliza 的完整桌面。amd64 · arm64 · riscv64。
- **Android**（[`packages/os/android`](packages/os/android)）— Eliza 作为系统启动器与助手，运行于 Pixel 级别设备。

该 OS 现已可启动；完整设备认证与正式更新渠道仍在推进中 —— 各目标平台的 README 可查看状态。

## Eliza Cloud（可选）

可选的托管后端，用于突破单设备限制。绝非必需 —— 仅本地运行是一等公民方案。它提供：

- **Auth** — 账号与登录（OAuth/SIWS）。
- **Hosted inference** — 跨服务商的模型路由，按使用量计费。
- **Deploy** — 将智能体或应用部署到拥有独立域名的容器。
- **Sync & bridge** — 跨设备状态同步；从云端控制台驱动本地智能体。
- **Monetization** — 对已发布应用、智能体与 MCP 进行计量与创作者收益分成。

## 基于 elizaOS 构建

运行时为开源，可自行扩展。从 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)
```

运行时**与模型无关**（model-agnostic）（OpenAI、Anthropic、Gemini、Grok、Llama、本地 Eliza-1 等），通过少量原语扩展：

- **`@elizaos/core`**（[packages/core](packages/core)）— 智能体循环、插件模型，以及消息/记忆/状态原语。
- **`@elizaos/agent`**（[packages/agent](packages/agent)）— `AgentRuntime`、插件加载器与默认插件映射。
- **`@elizaos/app-core`**（[packages/app-core](packages/app-core)）— 运行智能体的 API + 控制台宿主。
- **`elizaos`**（[packages/elizaos](packages/elizaos)）— CLI：`create`、`info`、`upgrade`。

**插件（plugin）** 导出 `Plugin`，用于注册 **actions**（智能体执行的操作）、**providers**（提示上下文）、**services**（长生命周期单例）与 **evaluators**（响应后处理）。直接导入 `@elizaos/core` 即可在无 CLI 或 UI 的情况下使用运行时 —— 参见 [`packages/examples`](packages/examples) 以及 [`packages/benchmarks`](packages/benchmarks) 中的评测套件。完整指南：**[docs.elizaos.ai](https://docs.elizaos.ai/)**.

## 在 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
```

本仓库自包含 —— 运行时、CLI、控制台、原生 OS 分支、云端后端与官方插件均在此。每个包都有各自的 `README.md`；进入开发前请先阅读。目录结构见 [`AGENTS.md`](AGENTS.md)。

## 贡献

欢迎贡献。提交非平凡 PR 前请先开 issue。开 PR 前请阅读 [CONTRIBUTING.md](CONTRIBUTING.md) 以及 [AGENTS.md](AGENTS.md) 中的证据标准；可前端测试的变更需在 PR 正文中附上截图（JPG）、MP4 视频演示、日志，以及任何相关的真实 LLM 轨迹。通过 GitHub Project 看板协作的 Agent 与维护者，在认领看板任务前须遵循 [CONTRIBUTING.md](CONTRIBUTING.md) 中的协调流程。当前 MVP 工作在
[LifeOps Personal Assistant MVP 看板](https://github.com/orgs/elizaOS/projects/15)
以及 [Discussions](https://github.com/elizaOS/eliza/discussions); 中协调；进行中的设计文档见
[`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)

如需报告安全漏洞，请遵循 [SECURITY.md](SECURITY.md)；请勿公开提交 issue。

## License

MIT — 参见 [LICENSE](LICENSE)。