Skip to content

elizaos-tutorial

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

elizaos-tutorial

README.md

title nav_order has_children
ElizaOS Deep Dive
95
true

ElizaOS: Deep Dive Tutorial

Project: ElizaOS — Autonomous agents for everyone.

Stars License: MIT TypeScript

What Is ElizaOS?

ElizaOS is an open-source framework for building, deploying, and managing autonomous multi-agent AI systems. It provides a complete platform for creating AI agents — chatbots, business automation, game NPCs, and Web3-native agents that interact with blockchains and smart contracts.

Feature Description
Multi-Agent Orchestrate groups of specialized agents with delegation and coordination
Plugin System Modular architecture — model providers, connectors, actions, all via plugins
Character Files Configure agent personality, goals, and behavior via JSON definitions
Multi-Platform Discord, Telegram, Slack, X/Twitter, Farcaster connectors
Web3 Native Wallet management, smart contracts, DeFi, token operations
RAG Built-in Document ingestion, embeddings, retrieval-augmented generation
Model Agnostic OpenAI, Anthropic, Gemini, Llama, Grok — any LLM backend
Desktop & Web Tauri desktop app, React web dashboard, CLI tools

Current Snapshot (auto-updated)

Architecture Overview

graph TB
    subgraph Core["@elizaos/core"]
        RT[AgentRuntime]
        CHAR[Character System]
        MEM[Memory & RAG]
        EVENT[Event Pipeline]
    end

    subgraph Plugins["Plugin Ecosystem"]
        BOOT[plugin-bootstrap<br/>Actions, Providers]
        SQL[plugin-sql<br/>Database]
        CUSTOM[Custom Plugins<br/>Actions, Services, Models]
    end

    subgraph Connectors["Platform Connectors"]
        DC[Discord]
        TG[Telegram]
        TW[X/Twitter]
        SL[Slack]
        FC[Farcaster]
    end

    subgraph Infrastructure["Infrastructure"]
        SERVER[Express Server]
        CLIENT[React Dashboard]
        CLI[CLI Tools]
        APP[Desktop App]
    end

    Core --> Plugins
    Core --> Connectors
    Plugins --> Infrastructure
    Connectors --> EVENT
Loading

Tutorial Structure

Chapter Topic What You'll Learn
1. Getting Started Installation & Setup Install ElizaOS, create your first agent, run the server
2. Agent Runtime Core Engine AgentRuntime, lifecycle, state management, model invocation
3. Character System Agent Identity Character files, personality, goals, knowledge, behavior
4. Plugin Architecture Extensibility Actions, providers, evaluators, services, custom plugins
5. Memory & RAG Knowledge Conversation memory, embeddings, document ingestion, retrieval
6. Platform Connectors Multi-Platform Discord, Telegram, Slack, X/Twitter, unified event pipeline
7. Multi-Agent Orchestration Coordination Agent groups, delegation, worlds/rooms, coordination patterns
8. Production Deployment Operations Docker, monitoring, Web3 integration, scaling, security

Tech Stack

Component Technology
Language TypeScript
Runtime Bun / Node.js >= 23
Build Turbo (monorepo), Lerna (releases)
Server Express.js, Socket.IO
Web UI React
Desktop Tauri
Database PostgreSQL, PGLite (embedded)
Embeddings Model-agnostic (OpenAI, local)

Prerequisites

  • Node.js >= 23 or Bun
  • An LLM API key (OpenAI, Anthropic, etc.)
  • PostgreSQL (optional — PGLite works out of the box)

Ready to begin? Start with Chapter 1: Getting Started.

Built with insights from the ElizaOS repository and community documentation.

Navigation & Backlinks

Full Chapter Map

  1. Chapter 1: Getting Started with ElizaOS
  2. Chapter 2: Agent Runtime
  3. Chapter 3: Character System
  4. Chapter 4: Plugin Architecture
  5. Chapter 5: Memory & RAG
  6. Chapter 6: Platform Connectors
  7. Chapter 7: Multi-Agent Orchestration
  8. Chapter 8: Production Deployment

Source References

Generated by AI Codebase Knowledge Builder