## 项目概述

elizaOS 是一个开源的 TypeScript 框架和产品栈，用于构建自主 AI 代理。该仓库是一个 monorepo，包含核心运行时、Eliza 应用、CLI、云服务、原生桥接和第一方插件。可启动的 Linux 和 Android 发行版位于单独的 [`elizaOS/os`](https://github.com/elizaOS/os) 仓库中。

## 核心功能

- **Eliza 应用**：面向 Web、桌面和移动端的用户代理应用，支持聊天、语音、记忆、知识、文档工作流，以及消息和 workspace 连接器。
- **框架**：模型无关的 `@elizaos/core` 定义 `AgentRuntime`、消息循环、记忆和状态原语，以及插件契约。
- **插件系统**：插件可注册 actions、providers、evaluators、services、model handlers、routes、events、tests 和 app views。
- **本地推理**：`@elizaos/plugin-local-inference` 提供设备端推理路径，支持 Gemma 4 的 2B、4B、9B、27B 文本模型，以及本地嵌入、语音、视觉和图像生成。
- **Eliza Cloud**：可选的云服务，提供账户认证、托管模型路由、应用和代理部署、远程连接和跨设备服务。
- **CLI 工具**：`elizaos` CLI 用于项目脚手架、插件创建、升级和部署。

## 适用与不适用场景

**适用场景**：
- 构建自主 AI 代理，集成聊天、语音、记忆和知识管理。
- 开发自定义插件以扩展代理能力。
- 需要本地推理或云服务混合部署的场景。
- 需要跨平台（Web、桌面、移动）的代理应用。

**不适用场景**：
- 需要完整操作系统级功能（如启动 Linux 或 Android 设备）时，应使用 [`elizaOS/os`](https://github.com/elizaOS/os) 仓库。
- 对 TypeScript 不熟悉或希望使用其他语言进行深度定制的场景。
- 需要轻量级、无依赖的代理框架时，此仓库可能过于庞大。

## 技术架构与依赖

- **语言**：TypeScript
- **运行时**：Bun（推荐）和 Node.js（版本在 `package.json` 中固定）
- **包管理**：Bun（`bun install`）
- **构建工具**：Turbo（`bun run build`）
- **主要包**：
  - `@elizaos/core`：核心运行时和类型定义
  - `@elizaos/agent`：独立代理和 HTTP 后端
  - `@elizaos/app-core`：应用托管和 API 编排
  - `@elizaos/ui`：共享 React UI
  - `elizaos`：CLI 工具
- **插件**：位于 `plugins/` 目录，包括模型、连接器、领域、应用和设备插件。

## 安装与快速开始

### 从源码运行

```bash
git clone --filter=blob:none https://github.com/elizaos/eliza.git
cd eliza
bun install
bun run dev
```

对于较小的开发安装，跳过大型工件包，使用 `bun run install:light`。

### 使用 CLI 构建

```bash
bun add --global elizaos@beta
elizaos create my-project --template project
elizaos create plugin-example --template plugin
```

## 典型使用方法

- **运行 Eliza 应用**：使用 `bun run dev` 启动开发服务器，或使用发布的 GitHub release。
- **构建代理或插件**：使用 `elizaos` CLI 创建项目或插件模板，然后根据文档开发。
- **嵌入运行时**：直接导入 `@elizaos/core` 以在自定义应用中使用。
- **运行测试**：使用 `bun run test` 进行单元/集成测试，`bun run test:e2e` 进行端到端测试。

## 配置与部署要点

- **环境变量**：配置模型提供商、API 密钥等，具体参考各包 README。
- **本地推理**：需要下载模型资产，硬件检测和模型路由选择支持的 backend。
- **Eliza Cloud**：可选，提供托管服务，但本地运行时和直接模型提供商配置仍是第一类路径。
- **部署**：使用 `elizaos` CLI 进行部署，或参考文档中的部署指南。

## 限制、风险与许可证

- **限制**：功能可用性取决于操作系统、安装的插件、授予的权限和配置的模型/服务提供商。
- **风险**：本地推理需要下载大型模型资产，可能占用存储和计算资源。
- **许可证**：MIT 许可证。

## 官方链接

- [GitHub 仓库](https://github.com/elizaOS/eliza)
- [Eliza 应用](https://eliza.app)
- [Eliza Cloud](https://app.elizacloud.ai)
- [文档](https://docs.elizaos.ai/)
- [插件目录](https://plugins.elizacloud.ai)
- [elizaOS 下载](https://os.elizacloud.ai)

## 信息来源和分析时间

- 信息来源：GitHub 仓库 README、CONTRIBUTING.md、仓库元数据。
- 分析时间：2026年8月1日。