elizaOS / eliza
Autonomous agents for everyone
AI Architecture Analysis
This repository is indexed by RepoMind. By analyzing elizaOS/eliza in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.
Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.
Repository Summary (README)
Preview⨠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:
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 providesAgentRuntime, 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}
}