Repository: elizaOS/eliza

Stars: 18197

README.md

<div align="center">
<h1>elizaOS</h1>
<p><strong>The Open-Source Framework for Multi-Agent AI Development</strong></p>
<p>Build, deploy, and manage autonomous AI agents with a modern, extensible, and full-featured platform.</p>
</div>

✨ 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, a powerful CLI, and a rich web interface to give 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.

Looking for plugins? Browse the community plugin registry at elizaOS-plugins/registry for a full list of available ElizaOS plugins.

🏁 Getting Started (5-Minute Quick Start)

There are two recommended paths for using Eliza:

- For Beginners & Standalone Projects (CLI): If you want to create and deploy agents without modifying Eliza's core code, the CLI is the fastest and simplest method. The guide below is for you.

- For Power Users & Contributors (Monorepo): If you plan to contribute to Eliza, create complex custom plugins, or manage multiple projects in one place, we recommend cloning the full monorepo. See the How to Contribute section to get started.

---

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

Prerequisites:

- Node.js (v23+)
- bun

Note for Windows Users: WSL 2 is required.

1. Install the CLI

bash

Install the elizaOS CLI globally

bun install -g @elizaos/cli
Verify installation

elizaos --version

2. Create Your Project

bash

Create a new project with an interactive setup

elizaos create my-first-agent
Follow the prompts. For beginners, we recommend:

- Database: pglite (no setup required)

- Model Provider: openai

- Project Type: project

3. Configure Your API Key

bash

cd my-first-agent
Open the local environment file

elizaos env edit-local

Add your model provider's API key (e.g., for OpenAI):

env

OPENAI_API_KEY=your_api_key_here

4. Start Your Agent

bash

Build and start the agent server

elizaos start

Your agent is now running!

- Web Interface: http://localhost:3000
- API Endpoint: http://localhost:3000/api

---

<details>
<summary>📚 Advanced CLI Commands & Usage</summary>

Eliza's CLI is powerful. Here are some more commands for development and management.

#### Development Workflow

bash

Make changes to your agent code, then rebuild and restart

bun run build
elizaos start
Or, start in development mode with auto-rebuild

elizaos dev
Run tests to verify your changes

elizaos test

#### Agent & Environment Management

bash

List all available agents

elizaos agent list
Start a specific agent by name

elizaos agent start --name "MyAgent"
Show all environment variables

elizaos env list

#### Debugging

bash

Start with detailed debug logging

LOG_LEVEL=debug elizaos start

For a full command reference, run elizaos --help or elizaos <command> --help.

</details>

---

🔧 Running elizaOS Core Standalone

Use elizaOS agents directly in your applications without the CLI or web interface.

bash

git clone https://github.com/elizaos/eliza.git
cd eliza
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

🏛️ Architecture Overview

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

text

/
├── packages/
│   ├── server/         # Core backend server (Express.js)
│   ├── client/         # Frontend web interface (React)
│   ├── cli/            # Command-line tool for managing projects
│   ├── core/           # Shared utilities, basic-capabilities plugin, and functions
│   ├── app/            # Cross-platform desktop app (Tauri)
│   ├── plugin-sql/     # Database integration (Postgres, PGLite)
│   └── ...             # Other plugins and project starters
└── ...

- @elizaos/server: The Express.js backend that runs your agents and exposes the API.
- @elizaos/client: The React-based web UI for managing and interacting with your agents.
- @elizaos/cli: The central tool for scaffolding, running, and managing your projects.
- @elizaos/core: The core package that includes the basic-capabilities plugin which handles message processing and basic agent actions.

🤝 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:

bibtex

@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

![Star History Chart](https://star-history.com/#elizaos/eliza&Date)

Repository: elizaOS/eliza

Stars: 18197

README.md Copy Chapter

✨ What is Eliza? Copy Chapter

🚀 Key Features Copy Chapter

🏁 Getting Started (5-Minute Quick Start) Copy Chapter

1. Install the CLI Copy Section

Install the elizaOS CLI globally

Verify installation

2. Create Your Project Copy Section

Create a new project with an interactive setup

Follow the prompts. For beginners, we recommend:

- Database: pglite (no setup required)

- Model Provider: openai

- Project Type: project

3. Configure Your API Key Copy Section

Open the local environment file

4. Start Your Agent Copy Section

Build and start the agent server

Make changes to your agent code, then rebuild and restart

Or, start in development mode with auto-rebuild

Run tests to verify your changes

List all available agents

Start a specific agent by name

Show all environment variables

Start with detailed debug logging

🔧 Running elizaOS Core Standalone Copy Chapter

Interactive chat

Basic message processing

🏛️ Architecture Overview Copy Chapter

🤝 How to Contribute Copy Chapter

📜 License Copy Chapter

🎓 Citation Copy Chapter

Contributors Copy Chapter

Star History Copy Chapter

README.md

✨ What is Eliza?

🚀 Key Features

🏁 Getting Started (5-Minute Quick Start)

1. Install the CLI

2. Create Your Project

3. Configure Your API Key

4. Start Your Agent

🔧 Running elizaOS Core Standalone

🏛️ Architecture Overview

🤝 How to Contribute

📜 License

🎓 Citation

Contributors

Star History