✨ 什么是Eliza？

elizaOS是一个一体化、可扩展的平台，用于构建和部署人工智能驱动的应用程序。无论您是创建复杂的聊天机器人、用于业务流程自动化的自主智能体，还是智能游戏NPC，Eliza都能为您提供所需的工具，帮助您快速入门并有效扩展。

它结合了模块化架构、强大的CLI和丰富的Web界面，让您全面掌控智能体的开发、部署和管理生命周期。

如需完整指南和API参考，请访问我们的官方**文档**。

🚀 核心特性

• 🔌 丰富的连接性：开箱即用的Discord、Telegram、Farcaster等连接器。
• 🧠 模型无关：支持所有主流模型，包括OpenAI、Gemini、Anthropic、Llama和Grok。
• 🖥️ 现代Web界面：专业的仪表盘，可实时管理智能体、群组和对话。
• 🤖 多智能体架构：从头设计，专为创建和编排专业智能体群组而打造。
• 📄 文档导入：轻松导入文档，使智能体能够从您的数据中检索信息并回答问题（RAG）。
• 🛠️ 高度可扩展：通过强大的插件系统构建您自己的功能。
• 📦 开箱即用：从第一天起即可享受无缝的设置和开发体验。

寻找插件？ 请浏览社区插件注册表**elizaOS-plugins/registry**，获取完整的ElizaOS插件列表。

🏁 快速入门（5分钟）

使用Eliza有两种推荐方式：

• 面向初学者和独立项目（CLI）： 如果您希望在不修改Eliza核心代码的情况下创建和部署智能体，CLI是最快速、最简单的方法。以下指南适合您。

• 面向高级用户和贡献者（Monorepo）： 如果您计划为Eliza做出贡献、创建复杂的自定义插件，或在一个地方管理多个项目，我们建议克隆完整的monorepo。请参阅【如何贡献】部分开始操作。

只需几个命令，即可运行您的第一个AI智能体。

先决条件：

• Node.js（v23+）
• bun

Windows用户注意： 需要安装WSL 2。

1. 安装CLI

# 全局安装elizaOS CLI
bun install -g @elizaos/cli

# 验证安装
elizaos --version

2. 创建您的项目

# 使用交互式设置创建新项目
elizaos create my-first-agent

# 按照提示操作。对于初学者，我们建议：
# - 数据库：pglite（无需设置）
# - 模型提供商：openai
# - 项目类型：project

3. 配置您的API密钥

cd my-first-agent

# 打开本地环境文件
elizaos env edit-local

添加您的模型提供商的API密钥（例如OpenAI）：

OPENAI_API_KEY=your_api_key_here

4. 启动您的智能体

# 构建并启动智能体服务器
elizaos start

您的智能体现已运行！

• Web界面：http://localhost:3000
• API端点：http://localhost:3000/api

# 对智能体代码进行更改后，重新构建并重启
bun run build
elizaos start

# 或者以开发模式启动，并启用自动重建
elizaos dev

# 运行测试以验证您的更改
elizaos test

# 列出所有可用的智能体
elizaos agent list

# 按名称启动特定智能体
elizaos agent start --name "MyAgent"

# 显示所有环境变量
elizaos env list

# 以详细调试日志启动
LOG_LEVEL=debug elizaos start

🔧 独立运行 elizaOS Core

无需 CLI 或 Web 界面，即可在您的应用中直接使用 elizaOS 代理。

git clone https://github.com/elizaos/eliza.git
cd eliza

# 交互式聊天
OPENAI_API_KEY=your_key bun run examples/typescript/chat.ts

# 基本消息处理
OPENAI_API_KEY=your_key bun run examples/typescript/standalone.ts

🏛️ 架构概览

Eliza 是一个 monorepo，包含了运行整个平台所需的所有包。

/
├── packages/
│   ├── server/         # 核心后端服务器（Express.js）
│   ├── client/         # 前端 Web 界面（React）
│   ├── cli/            # 用于管理项目的命令行工具
│   ├── core/           # 共享工具、基础能力插件和函数
│   ├── app/            # 跨平台桌面应用（Tauri）
│   ├── plugin-sql/     # 数据库集成（Postgres、PGLite）
│   └── ...             # 其他插件和项目脚手架
└── ...

• @elizaos/server: 运行您的代理并暴露 API 的 Express.js 后端。
• @elizaos/client: 基于 React 的 Web UI，用于管理和与您的代理交互。
• @elizaos/cli: 用于搭建、运行和管理项目的中心化工具。
• @elizaos/core: 核心包，包含处理消息和执行基本代理操作的基础能力插件。

🤝 如何贡献

我们欢迎社区的贡献！请阅读我们的 CONTRIBUTING.md 指南以开始。

• 报告 Bug：使用 Bug Report 模板提交问题。
• 请求功能：使用 Feature Request 模板。
• 提交 Pull Request：请先打开一个问题，讨论您提议的更改。

📜 许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。

🎓 引用

如果您在研究中使用 Eliza，请引用我们的论文：

@article{walters2025eliza,
  title={Eliza: A Web3 friendly AI Agent Operating System},
  author={Walters, Shaw and Gao, Sam and Nerd, Shakker and Da, Feng and Williams, Warren and Meng, Ting-Chien and Han, Hunter and He, Frank and Zhang, Allen and Wu, Ming and others},
  journal={arXiv preprint arXiv:2501.06781},
  year={2025}
}

贡献者

星标历史

ElizaOS 快速上手指南

ElizaOS 是一个开源的多智能体 AI 开发框架，支持快速构建、部署和管理自主 AI 代理（Agent）。它具备模块化架构、丰富的插件系统以及现代化的 Web 管理界面，适用于聊天机器人、自动化任务代理及游戏 NPC 等场景。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：
  • Linux / macOS：直接支持。
  • Windows：必须安装并启用 WSL 2 (Windows Subsystem for Linux)。
• 运行时依赖：
  • Node.js：版本需为 v23+。
  • Bun：高性能 JavaScript 运行时（用于包管理和执行）。

国内用户提示：如果访问官方源较慢，建议在安装 Bun 和 npm 包时配置国内镜像源（如淘宝镜像）。

安装步骤

1. 安装 CLI 工具

使用 Bun 全局安装 ElizaOS 命令行工具：

# 全局安装 elizaOS CLI
bun install -g @elizaos/cli

# 验证安装是否成功
elizaos --version

2. 创建新项目

运行创建命令，跟随交互式提示初始化项目：

# 创建名为 my-first-agent 的新项目
elizaos create my-first-agent

配置建议（针对初学者）：

• Database: 选择 pglite (无需额外配置数据库服务)。
• Model Provider: 选择 openai (或其他您拥有的密钥的服务商)。
• Project Type: 选择 project。

3. 配置 API 密钥

进入项目目录并编辑本地环境变量文件：

cd my-first-agent

# 打开本地环境配置文件
elizaos env edit-local

在打开的文件中添加您的大模型 API Key（以 OpenAI 为例）：

OPENAI_API_KEY=your_api_key_here

基本使用

启动 Agent

完成配置后，构建并启动代理服务：

# 构建并启动
elizaos start

启动成功后，您可以通过以下方式访问：

• Web 管理界面: http://localhost:3000
• API 端点: http://localhost:3000/api

开发模式

如果您正在修改代码并希望自动重载，可以使用开发模式：

# 启动开发模式（支持自动重建）
elizaos dev

常用管理命令

• 查看可用代理列表：

  elizaos agent list
  

• 启动指定名称的代理：

  elizaos agent start --name "MyAgent"
  

• 开启调试日志：

  LOG_LEVEL=debug elizaos start
  

现在，您已经成功运行了第一个 AI 代理，可以在 Web 界面中与其对话或进行进一步的功能扩展。