elizaOS

面向多智能体 AI 开发的开源框架

通过一个现代、可扩展且功能齐全的平台，构建、部署并管理自主 AI 智能体。

✨ 什么是 Eliza？

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

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

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

🚀 核心功能

🔌 丰富的连接性：提供针对 Discord、Telegram、Farcaster 等平台的开箱即用连接器。
🧠 模型不可知：支持所有主流模型，包括 OpenAI、Gemini、Anthropic、Llama 和 Grok。
🖥️ 现代 Web UI：专业的仪表板，用于实时管理智能体、群组和对话。
🤖 多智能体架构：从底层设计，支持创建和编排多个专业智能体集群。
📄 文档摄入：轻松摄入文档，允许智能体检索信息并基于您的数据回答问题（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 Key

cd my-first-agent

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

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

OPENAI_API_KEY=your_api_key_here

4. 启动智能体

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

您的智能体现已运行！

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

📚 高级 CLI 命令与用法

Eliza 的 CLI 功能非常强大。以下是一些用于开发和管理的进阶命令。

开发工作流

# 修改智能体代码后，重新构建并重启
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 --help 或 elizaos <command> --help。

🔧 独立运行 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/           # 共享工具库、基础功能

elizaOS/eliza