eliza Documentation

1. Project Overview & Quickstart (elizaOS/eliza) Copy Chapter

elizaOS is an open-source TypeScript framework and product stack for autonomous
AI agents. This monorepo contains the core runtime, the Eliza app, the CLI,
cloud services, native bridges, and first-party plugins. The bootable Linux and
Android distributions live in the separate
elizaOS/os repository.

Choose a starting point Copy Chapter

Run Eliza from source Copy Chapter

The repository pins Bun and Node versions in package.json.
Install those versions, then:

git clone --filter=blob:none https://github.com/elizaos/eliza.git
cd eliza
bun install
bun run dev

bun install also prepares submodules and patches. The legacy archive
artifact bundle is never pulled implicitly; fetch it deliberately with
bun run fetch:archive-artifacts if you need those fixtures.

Common repository commands:

bun run build       # build the workspace with Turbo
bun run verify      # package parity, dependency, type, lint, and audit gates
bun run test        # repository unit/integration test lane
bun run test:e2e    # end-to-end lane
bun run cloud:mock  # local Eliza Cloud stack with mocks

See AGENTS.md for package scoping, shared development servers, and
the evidence required before a change is considered complete.

What is in the stack? Copy Chapter

Eliza Copy Section

Eliza is the user-facing agent app for web, desktop, and mobile targets. Its
capabilities are supplied by the runtime and installed plugins, including:

• chat, voice, memory, knowledge, and document workflows;
• messaging and workspace connectors;
• calendar, reminders, inbox, goals, health, and other personal-assistant
  domains;
• browser and desktop automation;
• camera, phone, messages, contacts, location, and other native device bridges;
• non-custodial EVM and Solana wallet operations with approval boundaries; and
• scheduled workflows, coding-agent orchestration, and installable app views.

Availability depends on the operating system, installed plugins, granted
permissions, and configured model or service providers. Package-level READMEs
document the exact support and setup for each capability.

The framework Copy Section

The framework is model-agnostic and extended through plugins:

• @elizaos/core defines AgentRuntime, the canonical types,
  the message loop, memory and state primitives, and plugin contracts.
• @elizaos/agent assembles a standalone agent and HTTP
  backend around the core runtime.
• @elizaos/app-core provides shared application hosting,
  API, and platform orchestration for Eliza app targets.
• @elizaos/ui contains the shared React UI used by app
  surfaces.
• elizaos is the project and plugin scaffolding, upgrade,
  and deployment CLI.

A plugin exports a Plugin object. Plugins can register actions, providers,
evaluators, services, model handlers, routes, events, tests, and app views. See
the plugin component guide and
the first-party implementations under plugins/.

Local inference Copy Section

@elizaos/plugin-local-inference provides the
Eliza-1 on-device path. The current Eliza-1 registry contains 2B, 4B, 9B, and
27B text tiers based on Gemma 4, plus local embeddings, speech, vision, and
image-generation assets. Hardware detection and model routing select supported
backends; after the required assets are downloaded, eligible operations can run
without a network connection.

Local inference is not forced on hardware that cannot support it. Eliza can
route each model capability to local, direct-provider, or Eliza Cloud backends.

Eliza Cloud Copy Section

Eliza Cloud is optional. It provides account and
authentication services, hosted model routing, application and agent
deployment, remote connectivity, and cross-device product services. The local
runtime and direct model-provider configuration remain first-class paths.

elizaOS distributions Copy Section

The standalone elizaOS/os repository owns
bootable Linux and AOSP distributions, installers, release manifests, and OS
toolchains. This monorepo retains the Eliza application shells and native
runtime bridges used by desktop, iOS, Android, and device integrations.

Build with `elizaos` Copy Chapter

The beta CLI published from this branch uses the unscoped elizaos package:

bun add --global elizaos@beta
elizaos create my-project --template project
elizaos create plugin-example --template plugin

Projects are deployable workspaces; plugins are reusable capability packages.
The packaged templates and their scaffold contracts live in
packages/elizaos/templates/.

To embed the runtime directly without the CLI or application host, import
@elizaos/core. The scenario runner provides executable integration coverage
against a real runtime and, when configured, live models.

Repository map Copy Chapter

packages/        runtime, hosts, UI, CLI, docs, cloud, native code, and tooling
plugins/         first-party model, connector, domain, app, and device plugins
scripts/         repository-wide checks, test orchestration, and release tools
patches/         dependency patches applied during installation

Every maintained package or plugin should explain its public surface, scripts,
configuration, and local constraints in its own README.md and paired
CLAUDE.md / AGENTS.md. Read the nearest package guide before making changes.

Contributing Copy Chapter

Open an issue before a non-trivial change and submit work through a pull request
against develop. CONTRIBUTING.md defines the coordination,
testing, synchronization, and human-verifiable evidence requirements.

• Bug Report
• Feature Request
• Agent Work Item
• Windows setup
• Security policy
• Security architecture documentation

Report vulnerabilities privately through the security policy,
not a public issue.

License Copy Chapter

MIT

2. Official Technical Reference & Guides (elizaOS/docs) Copy Chapter

ElizaOS Documentation

Welcome to the official documentation repository for ElizaOS - a powerful framework for building AI agents with memory, planning, and tool use capabilities.

📚 About This Documentation Copy Chapter

This repository contains the comprehensive documentation for ElizaOS, including:

• Getting Started - Quick setup guides and tutorials
• Core Concepts - Understanding agents, plugins, and the architecture
• Deep Dive - Advanced topics like memory systems, services, and event handling
• REST Reference - Complete REST API documentation for all modules
• Examples - Real-world implementations and patterns

Development Copy Chapter

Prerequisites Copy Section

• Node.js (v23 or higher)
• bun (or npm/yarn)

Local Development Setup Copy Section

Install the Mintlify CLI to preview the documentation changes locally:

bun install -g mint

Running Locally Copy Section

Navigate to the root of your documentation (where docs.json is located) and run:

mint dev

This will start a local development server at http://localhost:3000 where you can preview your changes in real-time.

Project Structure Copy Section

docs/
├── rest-reference/      # REST API documentation
├── core-concepts/      # Core concepts and architecture
├── deep-dive/         # Advanced topics
├── images/            # Documentation images
├── logo/              # Logo assets
├── snippets/          # Reusable code snippets
├── docs.json          # Mintlify configuration
├── index.mdx          # Landing page
├── quickstart.mdx     # Quick start guide
└── development.mdx    # Development guide

📝 Contributing to Documentation Copy Chapter

We welcome contributions to improve the ElizaOS documentation! Here's how you can help:

1. Fork this repository
2. Create a new branch for your changes
3. Make your documentation improvements
4. Test locally using mint dev
5. Submit a pull request

Documentation Guidelines Copy Section

• Use clear, concise language
• Include code examples where appropriate
• Follow the existing structure and formatting
• Test all code snippets
• Add images/diagrams for complex concepts

Publishing Changes Copy Chapter

Changes are automatically deployed when merged to the main branch. The documentation is hosted using Mintlify's infrastructure.

Deployment Process Copy Section

1. Install the Mintlify GitHub App on your repository
2. Push changes to your default branch
3. Changes will be automatically deployed to production

Find the installation link in your Mintlify dashboard.

🔧 Troubleshooting Copy Chapter

Common Issues Copy Section

• Dev environment not running

  • Run mint update to ensure you have the latest version of the CLI
  • Check that you're in the correct directory with docs.json

• Page loads as 404

  • Ensure you're running the command in a folder containing docs.json
  • Check that your page is properly listed in the navigation

• Changes not reflecting

  • Clear your browser cache
  • Restart the development server
  • Check for syntax errors in your MDX files

📖 Learn More Copy Chapter

• ElizaOS GitHub Repository
• Mintlify Documentation
• MDX Documentation

📄 License Copy Chapter

This documentation is part of the ElizaOS project. Please refer to the main repository for license information.

Built with ❤️ using Mintlify