Quickstart
Get Eliza up and running in under 5 minutes
Prerequisites
Before you begin, make sure you have the following installed:
Node.js 23.3
Install Node.js version 23.3 or higher
Bun
Install Bun runtime for faster package management
Quick Installation
Follow these steps to get Eliza running quickly:
Install Eliza CLI
Install the Eliza CLI globally using Bun:
Create Your Agent
Create a new Eliza agent with your chosen name:
Replace <agent-name>
with your desired agent name.
Configure Your Agent
During the setup process, you’ll be prompted to make the following selections:
- Database: Select
pglite
for a lightweight PostgreSQL option - Model Provider: Select
openai
- API Key: Provide your OpenAI API key when prompted
Make sure you have your OpenAI API key ready. You can get one from the OpenAI Platform.
Navigate to Your Agent
Change directory to your newly created agent:
Start Your Agent
Launch your Eliza agent:
Your agent is now running and ready to interact!
Chat with Eliza
Open your browser and navigate to:
Start chatting with your Eliza agent through the web interface!
What’s Next?
Explore Eliza
Check out the main Eliza repository for more advanced features and configurations
Customize Your Agent
Learn how to customize your agent’s personality, capabilities, and integrations
Deploy Your Agent
Ready to go live? Learn how to deploy your agent to production
Join the Community
Connect with other Eliza developers and get support
Troubleshooting
Node.js version issues
Node.js version issues
OpenAI API key errors
OpenAI API key errors
If you’re getting authentication errors:
- Verify your API key is correct
- Check that your OpenAI account has available credits
- Ensure your API key has the necessary permissions
Database connection issues
Database connection issues
If pglite isn’t working properly:
- Try restarting the agent
- Check that the database files have proper permissions
- Consider using a different database option if issues persist