
eliza
Autonomous agents for everyone
Stars: 15281

README:
๐ Technical Report | ๐ Documentation | ๐ฏ Examples
ไธญๆ่ฏดๆ | ๆฅๆฌ่ชใฎ่ชฌๆ | ํ๊ตญ์ด ์ค๋ช | Persian | Franรงais | Portuguรชs | Tรผrkรงe | ะ ัััะบะธะน | Espaรฑol | Italiano | เนเธเธข | Deutsch | Tiแบฟng Viแปt | ืขึดืืจึดืืช | Tagalog | Polski | Arabic | Hungarian | Srpski | Romรขnฤ | Nederlands | ฮฮปฮปฮทฮฝฮนฮบฮฌ
- ๐ ๏ธ Full-featured Discord, X (Twitter) and Telegram connectors
- ๐ Support for every model (Llama, Grok, OpenAI, Anthropic, Gemini, 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
- ๐ฆ Just works!
- ๐ค Chatbots
- ๐ต๏ธ Autonomous Agents
- ๐ Business Process Handling
- ๐ฎ Video Game NPCs
- ๐ง Trading
Note for Windows Users: WSL 2 is required.
Full steps and documentation can be found in the Eliza Starter Repository.
git clone https://github.com/elizaos/eliza-starter.git
cd eliza-starter
cp .env.example .env
pnpm i && pnpm build && pnpm start
# Clone the repository
git clone https://github.com/elizaos/eliza.git
# This project iterates fast, so we recommend checking out the latest release
git checkout $(git describe --tags --abbrev=0)
# If the above doesn't checkout the latest release, this should work:
# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
If you would like the sample character files too, then run this:
# Download characters submodule from the character repos
git submodule update --init
Copy .env.example to .env and fill in the appropriate values.
cp .env.example .env
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
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
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
Open another terminal, move to the same directory, run the command below, then follow the URL to chat with your agent.
pnpm start:client
Then read the Documentation to learn how to customize your Eliza.
The start script provides an automated way to set up and run Eliza:
sh scripts/start.sh
For detailed instructions on using the start script, including character management and troubleshooting, see our Start Script Guide.
Note: The start script handles all dependencies, environment setup, and character management automatically.
-
Open
packages/core/src/defaultCharacter.ts
to modify the default character. Uncomment and edit. -
To load custom characters:
- Use
pnpm start --characters="path/to/your/character.json"
- Multiple character files can be loaded simultaneously
- Use
-
Connect with X (Twitter)
- change
"clients": []
to"clients": ["twitter"]
in the character file to connect with X
- change
-
run
npx elizaos plugins list
to get a list of available plugins or visit https://elizaos.github.io/registry/ -
run
npx elizaos plugins add @elizaos-plugins/plugin-NAME
to install the plugin into your instance
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
Plugins that are not in the official registry for ElizaOS can be used as well. Here's how:
- Upload the custom plugin to the packages folder:
packages/
โโplugin-example/
โโโ package.json
โโโ tsconfig.json
โโโ src/
โ โโโ index.ts # Main plugin entry
โ โโโ actions/ # Custom actions
โ โโโ providers/ # Data providers
โ โโโ types.ts # Type definitions
โ โโโ environment.ts # Configuration
โโโ README.md
โโโ LICENSE
- Add the custom plugin to your project's dependencies in the agent's package.json:
{
"dependencies": {
"@elizaos/plugin-example": "workspace:*"
}
}
- Import the custom plugin to your agent's character.json
"plugins": [
"@elizaos/plugin-example",
],
Use Fleek to deploy Eliza in one click. This opens Eliza to non-developers and provides the following options to build your agent:
- Start with a template
- Build characterfile from scratch
- Upload pre-made characterfile
Click here to get started!
- GitHub Issues. Best for: bugs you encounter using Eliza, and feature proposals.
- elizaOS Discord. Best for: hanging out with the elizaOS technical community
- DAO Discord. Best for: hanging out with the larger non-technical community
We now have a paper you can cite for the Eliza OS:
@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}
}
- CPU: Dual-core processor
- RAM: 4GB
- Storage: 1GB free space
- Internet connection: Broadband (1 Mbps+)
- Python 2.7+ (3.8+ recommended)
- Node.js 23+
- pnpm
- Git
- GPU: For running local LLM models
- Additional storage: For document storage and memory
- Higher RAM: For running multiple agents
eliza/
โโโ packages/
โ โโโ core/ # Core Eliza functionality
โ โโโ clients/ # Client implementations
โ โโโ actions/ # Custom actions
โโโ docs/ # Documentation
โโโ scripts/ # Utility scripts
โโโ examples/ # Example implementations
We welcome contributions! Here's how you can help:
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes
- Run tests:
pnpm test
- Submit a pull request
- ๐ Bug fixes
- โจ New features
- ๐ Documentation improvements
- ๐ Translations
- ๐งช Test improvements
- Follow the existing code style
- Add comments for complex logic
- Update documentation for changes
- Add tests for new features
For Tasks:
Click tags to check more tools for each tasksFor Jobs:
Alternative AI tools for eliza
Similar Open Source Tools

one
ONE is a modern web and AI agent development toolkit that empowers developers to build AI-powered applications with high performance, beautiful UI, AI integration, responsive design, type safety, and great developer experience. It is perfect for building modern web applications, from simple landing pages to complex AI-powered platforms.

Shellsage
Shell Sage is an intelligent terminal companion and AI-powered terminal assistant that enhances the terminal experience with features like local and cloud AI support, context-aware error diagnosis, natural language to command translation, and safe command execution workflows. It offers interactive workflows, supports various API providers, and allows for custom model selection. Users can configure the tool for local or API mode, select specific models, and switch between modes easily. Currently in alpha development, Shell Sage has known limitations like limited Windows support and occasional false positives in error detection. The roadmap includes improvements like better context awareness, Windows PowerShell integration, Tmux integration, and CI/CD error pattern database.

farfalle
Farfalle is an open-source AI-powered search engine that allows users to run their own local LLM or utilize the cloud. It provides a tech stack including Next.js for frontend, FastAPI for backend, Tavily for search API, Logfire for logging, and Redis for rate limiting. Users can get started by setting up prerequisites like Docker and Ollama, and obtaining API keys for Tavily, OpenAI, and Groq. The tool supports models like llama3, mistral, and gemma. Users can clone the repository, set environment variables, run containers using Docker Compose, and deploy the backend and frontend using services like Render and Vercel.

NextChat
NextChat is a well-designed cross-platform ChatGPT web UI tool that supports Claude, GPT4, and Gemini Pro. It offers a compact client for Linux, Windows, and MacOS, with features like self-deployed LLMs compatibility, privacy-first data storage, markdown support, responsive design, and fast loading speed. Users can create, share, and debug chat tools with prompt templates, access various prompts, compress chat history, and use multiple languages. The tool also supports enterprise-level privatization and customization deployment, with features like brand customization, resource integration, permission control, knowledge integration, security auditing, private deployment, and continuous updates.

photo-ai
100xPhoto is a powerful AI image platform that enables users to generate stunning images and train custom AI models. It provides an intuitive interface for creating unique AI-generated artwork and training personalized models on image datasets. The platform is built with cutting-edge technology and offers robust capabilities for AI image generation and model training.

100x-LLM
This repository contains code snippets and examples from the 100x Applied AI cohort lectures. It includes implementations of LLM Workflows, RAG (Retrieval Augmented Generation), Agentic Patterns, Chat Completions with various providers, Function Calling, and more. The repository structure consists of core components like LLM Workflows, RAG Implementations, Agentic Patterns, Chat Completions, Function Calling, Hugging Face Integration, and additional components for various agent implementations, presentation generation, Notion API integration, FastAPI-based endpoints, authentication implementations, and LangChain usage examples.

orra
Orra is a tool for building production-ready multi-agent applications that handle complex real-world interactions. It coordinates tasks across existing stack, agents, and tools run as services using intelligent reasoning. With features like smart pre-evaluated execution plans, domain grounding, durable execution, and automatic service health monitoring, Orra enables users to go fast with tools as services and revert state to handle failures. It provides real-time status tracking and webhook result delivery, making it ideal for developers looking to move beyond simple crews and agents.

search_with_ai
Build your own conversation-based search with AI, a simple implementation with Node.js & Vue3. Live Demo Features: * Built-in support for LLM: OpenAI, Google, Lepton, Ollama(Free) * Built-in support for search engine: Bing, Sogou, Google, SearXNG(Free) * Customizable pretty UI interface * Support dark mode * Support mobile display * Support local LLM with Ollama * Support i18n * Support Continue Q&A with contexts.

ChatGPT-Next-Web
ChatGPT Next Web is a well-designed cross-platform ChatGPT web UI tool that supports Claude, GPT4, and Gemini Pro models. It allows users to deploy their private ChatGPT applications with ease. The tool offers features like one-click deployment, compact client for Linux/Windows/MacOS, compatibility with self-deployed LLMs, privacy-first approach with local data storage, markdown support, responsive design, fast loading speed, prompt templates, awesome prompts, chat history compression, multilingual support, and more.

VT.ai
VT.ai is a multimodal AI platform that offers dynamic conversation routing with SemanticRouter, multi-modal interactions (text/image/audio), an assistant framework with code interpretation, real-time response streaming, cross-provider model switching, and local model support with Ollama integration. It supports various AI providers such as OpenAI, Anthropic, Google Gemini, Groq, Cohere, and OpenRouter, providing a wide range of core capabilities for AI orchestration.

ps-fuzz
The Prompt Fuzzer is an open-source tool that helps you assess the security of your GenAI application's system prompt against various dynamic LLM-based attacks. It provides a security evaluation based on the outcome of these attack simulations, enabling you to strengthen your system prompt as needed. The Prompt Fuzzer dynamically tailors its tests to your application's unique configuration and domain. The Fuzzer also includes a Playground chat interface, giving you the chance to iteratively improve your system prompt, hardening it against a wide spectrum of generative AI attacks.

recommendarr
Recommendarr is a tool that generates personalized TV show and movie recommendations based on your Sonarr, Radarr, Plex, and Jellyfin libraries using AI. It offers AI-powered recommendations, media server integration, flexible AI support, watch history analysis, customization options, and dark/light mode toggle. Users can connect their media libraries and watch history services, configure AI service settings, and get personalized recommendations based on genre, language, and mood/vibe preferences. The tool works with any OpenAI-compatible API and offers various recommended models for different cost options and performance levels. It provides personalized suggestions, detailed information, filter options, watch history analysis, and one-click adding of recommended content to Sonarr/Radarr.