README.md

Eliza 🤖

📖 Documentation | 🎯 Examples

✨ Features

• 🛠️ Full-featured Discord, Twitter and Telegram connectors
• 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
• 👥 Multi-agent and room support
• 📚 Easily ingest and interact with your documents
• 💾 Retrievable memory and document store
• 🚀 Highly extensible - create your own actions and clients
• ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
• 📦 Just works!

🎯 Use Cases

• 🤖 Chatbots
• 🕵️ Autonomous Agents
• 📈 Business Process Handling
• 🎮 Video Game NPCs
• 🧠 Trading

🌍 Translations

Available Languages

• 中文说明
• 日本語の説明
• 한국어 설명
• Instructions en français
• Instruções em português

🚀 Quick Start

Prerequisites

• Python 2.7+
• Node.js 22+
• pnpm

Note for Windows Users: WSL is required

Edit the .env file

Copy .env.example to .env and fill in the appropriate values

cp .env.example .env

Edit the character file

1. Open src/core/defaultCharacter.ts to modify the default character

2. To load custom characters:

   • Use pnpm start --characters="path/to/your/character.json"
   • Multiple character files can be loaded simultaneously

Start Eliza

After setting up the .env file and character file, you can start the bot with the following command:

pnpm i
pnpm build
pnpm start

# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
pnpm clean

Additional Requirements

You may need to install Sharp. If you see an error when starting up, try installing it with the following command:

pnpm install --include=optional sharp

Community & contact

• GitHub Issues. Best for: bugs you encounter using Eliza, and feature proposals.
• Discord. Best for: sharing your applications and hanging out with the community.

Contributors

Star History