Packaging of eliza for the cloud
git clone https://github.com/meta-introspector/cloud-deployment-eliza/
cd cloud-deployment-eliza
nvm install --lts
nvm use --lts
pnpm install
pnpm build
pnpm rebuild
docker run -d -p 9411:9411 openzipkin/zipkin
Run just this
scripts/start.sh
does the first install
scripts/just_start.sh
then you can run this
agent/run.sh
afterwards you can just run this to debug the agent
For my client I use, not the baked in one, but this one:
git clone https://github.com/meta-introspector/eliza-starter pnpm start --characters="characters/eliza.character.json"
the --characters="characters/eliza.character.json" is hard coded on the client and must match the server version
nvm install --lts nvm use --lts rm -rf node_modules/ rm -rf dist/ pnpm i && pnpm build && pnpm start pnpm rebuild
docker run -d -p 9411:9411 openzipkin/zipkin
pnpm start
Run just this
`scripts/start.sh` does the first install
`scripts/just_start.sh` then you can run this
`agent/run.sh` afterwards you can just run this to debug the agent
<div align="center">
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
</div>
<div align="center">
📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
</div>
## 🌍 README Translations
[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md)
## 🚩 Overview
<div align="center">
<img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" />
</div>
## ✨ 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!
## Video Tutorials
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
## 🎯 Use Cases
- 🤖 Chatbots
- 🕵️ Autonomous Agents
- 📈 Business Process Handling
- 🎮 Video Game NPCs
- 🧠 Trading
## 🚀 Quick Start
### Prerequisites
- [Python 2.7+](https://www.python.org/downloads/)
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [pnpm](https://pnpm.io/installation)
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
### Use the Starter (Recommended)
```bash
git clone https://github.com/elizaos/eliza-starter.git
cd eliza-starter
cp .env.example .env
pnpm i && pnpm build && pnpm start
Once the agent is running, You should see the message to run "pnpm start:client" at the end. Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
pnpm start:client
Then read the Documentation to learn how to customize your Eliza.
# Clone the repository
git clone https://github.com/elizaos/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)
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
This will run everything to set up the project and start the bot with the default character.
sh scripts/start.sh
-
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
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
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
- GitHub Issues. Best for: bugs you encounter using Eliza, and feature proposals.
- Discord. Best for: sharing your applications and hanging out with the community.