Prerequisites

Before you begin, make sure you have the following installed:

Quick Installation

Follow these steps to get Eliza running quickly:

1

Install Eliza CLI

Install the Eliza CLI globally using Bun:

bun i -g @elizaos/cli
2

Create Your Agent

Create a new Eliza agent with your chosen name:

elizaos create <agent-name>

Replace <agent-name> with your desired agent name.

3

Configure Your Agent

During the setup process, you’ll be prompted to make the following selections:

  1. Database: Select pglite for a lightweight PostgreSQL option
  2. Model Provider: Select openai
  3. 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.

4

Navigate to Your Agent

Change directory to your newly created agent:

cd <agent-name>
5

Start Your Agent

Launch your Eliza agent:

elizaos start

Your agent is now running and ready to interact!

6

Chat with Eliza

Open your browser and navigate to:

http://localhost:3000

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