elizaOS

Getting Started

Get up and running with ElizaOS quickly and create your first AI agent

Welcome to ElizaOS! This guide will help you create your first AI agent in minutes. ElizaOS is a powerful framework for building multi-agent systems with support for Discord, Telegram, Twitter, and many more platforms.

Quick Start

Create your first agent in under 5 minutes

Installation

Detailed installation instructions and setup

Configuration

Configure your agent's personality and connections

Core Concepts

Learn about agents, actions, and providers

What You'll Learn

This getting started guide covers:

  • Prerequisites - System requirements and development environment setup
  • Installation - Multiple ways to install and run ElizaOS
  • First Agent - Create and configure your first AI agent
  • Platform Connections - Connect to Discord, Telegram, and other platforms
  • Basic Configuration - Set up API keys and customize behavior
  • Next Steps - Advanced features and development workflows

Prerequisites

Before you begin, ensure you have:

Node.js (v23.3.0 or higher)

Download from nodejs.org or use a version manager like nvm.

Install from bun.sh

API Keys for your chosen model provider

  • OpenAI API key (recommended for beginners)
  • Anthropic API key (for Claude models)
  • Or set up local models with Ollama

Windows Users: WSL 2 required

Install WSL 2 for Windows compatibility.

Choose Your Path

Perfect for: First-time users who want to see ElizaOS in action immediately. What you get: A working agent with basic configuration in under 5 minutes. Time required: 5-10 minutes Start Quick Setup →

Perfect for: Developers who want to understand the full installation process. What you get: Complete understanding of ElizaOS architecture and configuration options. Time required: 15-30 minutes Start Detailed Setup →

Project Types in v1.2.0

ElizaOS v1.2.0 introduces different project types for various use cases:

Project

Full ElizaOS application with all features - perfect for complete agent solutions

Plugin

Extend ElizaOS with custom functionality - for developers building extensions

Agent

Standalone agent character definition - for simple agent configurations

TEE

Trusted Execution Environment deployment - for secure, decentralized agents

Installation Methods

ElizaOS v1.2.0 offers multiple installation approaches:

The ElizaOS CLI is the fastest and most reliable way to get started:

# Install the CLI globally
bun install -g @elizaos/cli

# Create your first project (interactive mode)
elizaos create

# Or specify project type directly
elizaos create my-agent --type project

Manual Installation

For developers who prefer manual control:

# Clone the repository
git clone https://github.com/elizaOS/eliza.git
cd eliza

# Install dependencies
bun install
bun run build

Docker Setup

Run ElizaOS in a containerized environment:

# Using Docker Compose
docker-compose up -d

What's Next?

Once you've completed the basic setup:

Create Your First Agent

Follow the quick start guide to create and run your first agent

Connect to Platforms

Set up Discord, Telegram, or Twitter connections

Customize Behavior

Learn how to define your agent's personality and capabilities

Add Plugins

Extend your agent with powerful plugins from the community

Development Workflow

Learn about development commands and best practices

Testing & Deployment

Test your agent and deploy to production

Common Issues

Getting stuck? Check out our troubleshooting guide for solutions to common problems.

Quick Fixes

  • Node.js version issues: Ensure you're using Node.js v23.3.0 (exact version required)
  • CLI installation issues: Try bun update -g @elizaos/cli or reinstall with bun install -g @elizaos/cli
  • Permission errors: Fix with sudo chown -R $(whoami) ~/.bun or use sudo for global installs
  • API key errors: Verify your API keys are correctly set in the .env file
  • Port conflicts: ElizaOS uses port 3000 by default - ensure it's available or use --port option
  • Database connection errors: Check your database URL in .env or switch to pglite for development

Community & Support

Need help? Join our community:

Ready to build your first AI agent? Choose your path above and let's get started!

Installation

Complete guide to installing ElizaOS and setting up your development environment