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)

ethereum
Searching Database…

19.6K ·GitHub
Eliza
What is this?elizaOS is an open-source TypeScript framework and product stack for autonomous AI agents: the core runtime, the Eliza app, the CLI, cloud services, native bridges, and first-party plugins in one monorepo. Bootable OS builds live in a separate elizaOS/os repo.
Is this something I install and use as an app, or a framework I build agents with?Both. End users run Eliza, the agent app, on web, desktop, and mobile; developers get the @elizaos/core runtime, a scaffolding and deployment CLI, and a plugin system — or can import @elizaos/core directly as a library.
How do I get it running?Open the web app, grab a release from Eliza downloads, or run from source: install the Bun and Node versions pinned in package.json, then run 'bun install'. To build agents or plugins, install the elizaos CLI and follow the developer docs.
Does every capability work on every device out of the box?No — availability depends on the operating system, installed plugins, granted permissions, and configured model or service providers. Each package's README documents the exact support and setup for its features.
Can it run AI models locally, without an internet connection?Yes. The local-inference plugin provides an on-device Eliza-1 path: 2B, 4B, 9B, and 27B text tiers based on Gemma 4, plus local embeddings, speech, vision, and image generation. After the assets download once, eligible operations run offline.
Do I need a powerful GPU for the local models?Not necessarily: hardware detection and model routing select supported backends, and local inference is never forced on hardware that cannot handle it. Each capability can route to a local model, a direct provider, or Eliza Cloud.
What can the Eliza assistant actually do day to day?Chat, voice, memory, knowledge, and document workflows; messaging and workspace connectors; personal-assistant domains like calendar, reminders, inbox, goals, and health; browser and desktop automation; native device bridges for camera, messages, contacts, and location; plus scheduled workflows and coding-agent orchestration.
Can it manage crypto wallets?Yes — it supports non-custodial EVM and Solana wallet operations, with approval boundaries defining what the agent is allowed to do.
How do I build my own agent or plugin?Install the elizaos CLI (the beta publishes under the unscoped 'elizaos' package): a project is a deployable workspace, a plugin is a reusable capability package, and templates ship in packages/elizaos/templates. Plugins register actions, providers, evaluators, services, model handlers, routes, and events — or skip the CLI and import @elizaos/core directly.
Is there a full elizaOS operating system?Yes — bootable Linux and AOSP distributions, installers, and target guides live in the separate elizaOS/os repository for running a whole device as elizaOS. This monorepo keeps the app shells and native runtime bridges used by desktop, iOS, and Android.
What are similar projects?ruflo, brigade, LangBot, openclaw, OpenDots, hive, leon, hermes-agent
Which topics is it in?swarm, solana, wallet, crypto, ethereum, voice, plugins, ai-assistant, agentic, slack, discord, bun
Creator
elizaOS
Size
2 GB
Stars
19.6K
Updated
CommitOct 17Releasepr-evidence-11Aug 23
Age
2y
Commits · 90 Days