- 🛠️ 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!
Note for Windows Users: WSL 2 is required.
# Clone the repository
git clone https://github.com/bio-xyz/portal.git
#### Edit the .env file
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
#### Start CoreAgent + Portal frontend
Important! We now use Bun. If you are using npm, you will need to install Bun:
https://bun.sh/docs/installation
```bash
bun install
bun run build # npm will work too
bun run dev # npm will work too
Pulling from v2-develop:
git pull origin v2-develop
Pushing to the Bio repo:
git push bio-github v2-develop
Once the agent is running, you can visit http://localhost:3000 to interact with your agent through a web interface. The interface provides:
- Real-time chat with your agent
- Character configuration options
- Plugin management
- Memory and conversation history
The start script provides an automated way to set up and run Eliza:
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}
}This project uses git hooks to ensure code quality:
- pre-commit: Automatically formats staged files using Prettier before committing
To run the pre-commit hook manually:
bun run pre-commit