Video Tutorial: Your First Agent
Create Your First Agent
Let’s create a project with our default Eliza character that can chat and take actions.1
Create Your Project
Create a new elizaOS project using the interactive CLI:
Terminal
The CLI is for building agents and projects. The monorepo is only for contributing to elizaOS core. See CLI vs Monorepo.
2
Configure Your Project
During the interactive setup, you’ll be prompted to make the following selections:Both database and model provider choices can be reconfigured later.
- Project Name: Enter your desired project name
- Database: Select
pglite
for a lightweight, local PostgreSQL option - Model Provider: Select
OpenAI
for this quickstart guide - API Key: You’ll be prompted to enter your OpenAI API key
You can get an OpenAI API key from the OpenAI Platform.
3
Navigate to Your Project
Change directory to your newly created project (replace with your project name):
Terminal
4
Start Your Agent
Launch your elizaOS project:Wait a few seconds for the server to start up.
Terminal
5
Chat with Your Agent
Open your browser and navigate to:Start chatting with Eliza through the web interface!
Troubleshooting
API key issues
API key issues
If you’re getting authentication or configuration errors:Open your project in Cursor (or any IDE) and look at the Common issues:
.env
file in your project root. Make sure these are set correctly:- OpenAI API key is missing, invalid, or has extra spaces/quotes
- Wrong OpenAI API key format (should start with
sk-
) - OpenAI account has no credits remaining
elizaos env
Database connection issues
Database connection issues
If you’re having database issues, check your Common issues:
.env
file for the database path:- Database path is incorrect in
.env
file .eliza/.elizadb
directory doesn’t exist or has wrong permissions- Database corruption (recreate the project if this happens)
Other Common Issues
Other Common Issues
When in doubt, turn it off and on again:
- Stop the server with
Ctrl+C
, then start it again withelizaos start
- Check the installation guide to confirm you installed everything correctly
- If you can’t reach
http://localhost:3000
, delete your project and start fresh - Navigate to the folder containing your project, then run:
Terminal
- Follow the Quickstart steps again carefully