Eliza 🤖

🌍 README Translations

中文说明 | 日本語の説明 | 한국어 설명 | Français | Português | Türkçe | Русский | Español | Italiano

✨ 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

🚀 Quick Start

Prerequisites

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

Note for Windows Users: WSL 2 is required.

Use the Starter (Recommended)

git clone https://github.com/ai16z/eliza-starter.git

cp .env.example .env

pnpm i && pnpm start

Then read the Documentation to learn how to customize your Eliza.

Manually Start Eliza (Only recommended if you know what you are doing)

# Clone the repository
git clone https://github.com/ai16z/eliza.git

# Checkout the latest release
# This project iterates fast, so we recommend checking out the latest release
git checkout $(git describe --tags --abbrev=0)

Edit the .env file

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

cp .env.example .env

Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON

Automatically Start Eliza

This will run everything to setup the project and start the bot with the default character.

sh scripts/start.sh

Edit the character file

1. Open agent/src/character.ts to modify the default character. Uncomment and edit.

2. To load custom characters:

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

Manually Start Eliza

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