base on Autonomous agents for everyone <div align="center"> <h1>Eliza</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> <div align="center"> <!-- Badges will go here --> <a href="https://github.com/elizaos/eliza/blob/main/LICENSE"><img src="https://img.shields.io/github/license/elizaos/eliza?style=for-the-badge" alt="License"></a> <a href="https://www.npmjs.com/package/@elizaos/cli"><img src="https://img.shields.io/npm/v/@elizaos/cli?style=for-the-badge" alt="NPM Version"></a> <a href="https://docs.elizaos.ai/"><img src="https://img.shields.io/badge/Documentation-Read%20Docs-blue?style=for-the-badge" alt="Documentation"></a> <a href="https://github.com/elizaos/eliza/actions/workflows/image.yaml"><img src="https://img.shields.io/github/actions/workflow/status/elizaos/eliza/ci.yaml?branch=main&style=for-the-badge" alt="CI Status"></a> <a href="https://discord.gg/ai16z"><img src="https://img.shields.io/discord/1253563208833433701?style=for-the-badge&logo=discord" alt="Discord"></a> </div> ## ✨ What is Eliza? Eliza 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](https://docs.elizaos.ai/)**. ## 🚀 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) 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](#-how-to-contribute) section to get started. --- Get your first AI agent running in just a few commands. **Prerequisites:** - [Node.js](https://nodejs.org/) (v23+) - [bun](https://bun.sh/docs/installation) > **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) 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](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/examples # Interactive chat OPENAI_API_KEY=your_key bun run standalone-cli-chat.ts # Basic message processing OPENAI_API_KEY=your_key bun run standalone.ts ``` ## 🏛️ Architecture Overview Eliza is a monorepo that contains all the packages needed to run the entire platform. ``` / ├── packages/ │ ├── server/ # Core backend server (Express.js) │ ├── client/ # Frontend web interface (React) │ ├── cli/ # Command-line tool for managing projects │ ├── core/ # Shared utilities and functions │ ├── app/ # Cross-platform desktop app (Tauri) │ ├── plugin-bootstrap/ # Core communication and event handling plugin │ ├── 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/plugin-bootstrap`**: The mandatory core plugin that 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](.github/ISSUE_TEMPLATE/bug_report.md) template. - **Request a Feature**: Use the [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md) 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](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 <a href="https://github.com/elizaos/eliza/graphs/contributors"> <img src="https://contrib.rocks/image?repo=elizaos/eliza" alt="Eliza project contributors" /> </a> ## Star History [](https://star-history.com/#elizaos/eliza&Date) ", Assign "at most 3 tags" to the expected json: {"id":"12088","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"