elizaOS

The Open-Source Framework for Multi-Agent AI Development

Build, deploy, and manage autonomous AI agents with a modern, extensible, and full-featured platform.

✨ What is Eliza?

elizaOS is an all-in-one, extensible platform for building and deploying AI-powered applications. Whether you're creating sophisticated chatbots, autonomous agents for business process automation, or intelligent game NPCs, Eliza provides the tools you need to get started quickly and scale effectively.

It combines a modular architecture with a library-first approach, giving you full control over your agents' development, deployment, and management lifecycle.

For complete guides and API references, visit our official documentation.

🚀 Key Features

• 🔌 Rich Connectivity: Out-of-the-box connectors for Discord, Telegram, Farcaster, and more.
• 🧠 Model Agnostic: Supports all major models, including OpenAI, Gemini, Anthropic, Llama, and Grok.
• 🖥️ Modern Web UI: A professional dashboard for managing agents, groups, and conversations in real-time.
• 🤖 Multi-Agent Architecture: Designed from the ground up for creating and orchestrating groups of specialized agents.
• 📄 Document Ingestion: Easily ingest documents and allow agents to retrieve information and answer questions from your data (RAG).
• 🛠️ Highly Extensible: Build your own functionality with a powerful plugin system.
• 📦 It Just Works: A seamless setup and development experience from day one.

🏁 Getting Started (5-Minute Quick Start)

Get your first AI agent running in just a few steps.

Prerequisites:

• Node.js (v23+)
• bun

Note for Windows Users: WSL 2 is required.

1. Clone the Repository

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

2. Configure Your API Key

Create a .env file in the project root:

OPENAI_API_KEY=your_api_key_here

3. Run an Example Agent

# Interactive chat
OPENAI_API_KEY=your_key bun run examples/typescript/chat.ts

# Basic message processing
OPENAI_API_KEY=your_key bun run examples/typescript/standalone.ts

4. Use the Library in Your Own Project

Install the core package:

bun add @elizaos/core

Create an agent programmatically:

import { AgentRuntime } from "@elizaos/core";

const runtime = new AgentRuntime({
  character: {
    name: "MyAgent",
    bio: "A helpful AI assistant.",
  },
  plugins: [/* your plugins here */],
});

await runtime.initialize();

For complete guides and API references, visit our documentation.

🏛️ Architecture Overview

Eliza is a monorepo that contains all the packages needed to run the entire platform.

/
├── packages/
│   ├── typescript/     # Core package (@elizaos/core) - agent runtime, bootstrap plugin
│   ├── python/         # Python implementation of the core API
│   ├── rust/           # Rust implementation (native + WASM)
│   └── ...             # Other packages and utilities
├── plugins/            # Official plugins (discord, telegram, openai, etc.)
├── examples/           # Example agents and usage patterns
└── ...

• @elizaos/core: The core package that provides AgentRuntime, the bootstrap plugin, message processing, and basic agent actions.
• @elizaos/plugin-sql: Database integration (Postgres, PGLite).
• plugins/: Official plugins for Discord, Telegram, OpenAI, Anthropic, and many more.

🤝 How to Contribute

We welcome contributions from the community! Please read our CONTRIBUTING.md guide to get started.

• Report a Bug: Open an issue using the Bug Report template.
• Request a Feature: Use the Feature Request template.
• Submit a Pull Request: Please open an issue first to discuss your proposed changes.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

🎓 Citation

If you use Eliza in your research, please cite our paper:

@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}
}

Contributors

Star History