eliza README

The project's README from github.com/elizaOS/eliza. As one markdown file: README.md.

elizaOS

elizaOS

Your agentic operating system.

Eliza · Eliza Cloud · elizaOS downloads · Documentation · App catalog

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

Goal Start here
Use Eliza Open the web app, visit Eliza downloads, or use a published GitHub release
Run this repository Follow Run Eliza from source
Build an agent or plugin Install the elizaos CLI and read the developer docs
Contribute Read CONTRIBUTING.md and the repository guide in AGENTS.md
Run a whole device as elizaOS Use the installers and target guides in elizaOS/os

Run Eliza from source

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, provisions supported host build prerequisites, and builds or verifies the staged desktop libelizainference. The embedding GGUF remains runtime-managed and downloads automatically during local-inference warmup. Fetch archived artifact fixtures explicitly with bun run fetch:archive-artifacts when needed.

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?

Eliza

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

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

The framework is model-agnostic and extended through plugins:

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

@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

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

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

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

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

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.

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

License

MIT

eliza (elizaOS/eliza)

Searching Database…

19.6K ·GitHub
Что это такое?elizaOS — это open-source фреймворк на TypeScript и набор продуктов для автономных AI-агентов: основное рантайм-ядро, приложение Eliza, CLI, облачные сервисы, нативные мосты и собственные плагины — всё в одном монорепозитории. Загружаемые сборки ОС находятся в отдельном репозитории elizaOS/os.
Это приложение, которое я устанавливаю и пользуюсь, или фреймворк, с помощью которого я создаю агентов?И то, и другое. Обычные пользователи запускают Eliza — приложение с агентами — в браузере, на компьютере и на телефоне; разработчикам доступны рантайм @elizaos/core, CLI для создания и развёртывания проектов и система плагинов, либо можно подключать @elizaos/core напрямую как библиотеку.
Как его запустить?Откройте веб-приложение, скачайте релиз со страницы загрузок Eliza или запустите из исходников: установите версии Bun и Node, зафиксированные в package.json, затем выполните 'bun install'. Чтобы создавать агентов или плагины, установите CLI elizaos и следуйте документации для разработчиков.
Все ли возможности работают на любом устройстве сразу после установки?Нет — доступность зависит от операционной системы, установленных плагинов, выданных разрешений и настроенных провайдеров моделей или сервисов. В README каждого пакета точно описано, что поддерживается и как настраивается.
Может ли он запускать AI-модели локально, без интернета?Да. Плагин локального инференса даёт работающее прямо на устройстве направление Eliza-1: текстовые модели уровней 2B, 4B, 9B и 27B на основе Gemma 4, плюс локальные эмбеддинги, распознавание и синтез речи, зрение и генерация изображений. После однократной загрузки необходимых файлов подходящие операции работают офлайн.
Нужна ли мощная видеокарта для локальных моделей?Не обязательно: определение железа и маршрутизация моделей сами выбирают подходящие бэкенды, и локальный инференс никогда не принудительно включается на оборудовании, которое его не потянет. Каждая возможность может использовать локальную модель, прямого провайдера или Eliza Cloud.
Что ассистент Eliza умеет делать в повседневной жизни?Чаты, голос, память, база знаний и работа с документами; коннекторы к мессенджерам и рабочим пространствам; функции личного ассистента — календарь, напоминания, почта, цели и здоровье; автоматизация браузера и рабочего стола; нативные мосты к устройствам для камеры, сообщений, контактов и геолокации; плюс запланированные сценарии и оркестрация coding-агентов.
А криптокошельками он может управлять?Да — он поддерживает некастодиальные операции с кошельками EVM и Solana, а границы подтверждений определяют, что агенту разрешено делать.
Как создать своего агента или плагин?Установите CLI elizaos (бета-версия публикуется под нескопированным пакетом 'elizaos'): проект — это развёртываемое рабочее пространство, плагин — переиспользуемый пакет с возможностями, а шаблоны лежат в packages/elizaos/templates. Плагины регистрируют actions, providers, evaluators, services, обработчики моделей, маршруты и события — либо обойдитесь без CLI и подключите @elizaos/core напрямую.
Существует ли полноценная операционная система elizaOS?Да — загружаемые дистрибутивы Linux и AOSP, установщики и руководства по целевым платформам находятся в отдельном репозитории elizaOS/os, чтобы запустить целое устройство как elizaOS. В этом монорепозитории хранятся оболочки приложений и нативные рантайм-мосты, которые используются на десктопе, iOS и Android.
What are similar projects?ruflo, brigade, LangBot, openclaw, OpenDots, hive, leon, hermes-agent
Creator
elizaOS
Size
2 GB
Stars
19.6K
Age
2y
Commits · 90 Days