You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-26Lines changed: 37 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,33 +23,42 @@ For complete guides and API references, visit our official **[documentation](htt
23
23
24
24
> **Looking for plugins?** Browse the community plugin registry at **[elizaOS-plugins/registry](https://github.com/elizaOS-plugins/registry)** for a full list of available ElizaOS plugins.
25
25
26
-
## Framework vs. application
26
+
## Framework, Projects, And App Plugins
27
27
28
-
elizaOS is two things stacked together. Knowing which one you're working with makes everything else easier.
28
+
elizaOS is a framework plus packages built on top of it. Knowing which layer
29
+
you're working with keeps projects, plugins, and app surfaces from getting
30
+
mixed together.
29
31
30
32
**The framework** is the runtime: `@elizaos/core`, the agent loop, the plugin model (actions, providers, services, evaluators), the message/memory/state primitives, and the model-agnostic LLM layer. If you depend on `@elizaos/core` from your own code, you are using the framework.
31
33
32
-
**An application** is a product *built on* the framework. [`apps/app-companion`](apps/app-companion), [`apps/app-browser`](apps/app-browser), [`apps/app-knowledge`](apps/app-knowledge), [`apps/app-phone`](apps/app-phone), and the rest of [`apps/`](apps) are first-party examples. Each is a self-contained package with its own UI, runtime plugin, data model, and deployment story. They share the framework, not the implementation.
34
+
**A project** is a deployable product workspace built on the framework. A
35
+
generated project owns its branded app shell, usually under `apps/app` inside
36
+
that project workspace.
37
+
38
+
**An app plugin** is a runtime plugin that also contributes an app surface inside
39
+
Eliza. First-party app plugins live under [`plugins/app-*`](plugins), keep npm
40
+
names like `@elizaos/app-companion`, and are loaded by package name. They are
templates/ ← scaffolds used by `APP create` / `PLUGIN create` flows
61
+
templates/ ← scaffolds used by project and plugin create flows
53
62
```
54
63
55
64
A *plugin* sits between the two: framework-shaped (registers actions/providers/services with the runtime) but shipped and consumed like a product. Community plugins are listed at [elizaOS-plugins/registry](https://github.com/elizaOS-plugins/registry).
@@ -60,26 +69,26 @@ A *plugin* sits between the two: framework-shaped (registers actions/providers/s
60
69
|---|---|
61
70
| Try an agent in 5 minutes |[CLI quick start](#cli-quick-start)|
62
71
| Use the runtime from your own TypeScript code (no CLI, no UI) |[Standalone usage](#standalone-usage)|
63
-
| Build a new agent application|[Create a new app](#create-a-new-app)|
72
+
| Build a new deployable product|[Create a new project](#create-a-new-project)|
64
73
| Build a runtime plugin (action / provider / service) |[Create a new plugin](#create-a-new-plugin)|
65
74
| See how others did it |[Examples](#examples)|
66
75
| Evaluate or benchmark an agent |[Benchmarks](#benchmarks)|
67
76
| Read the docs |[docs.elizaos.ai](https://docs.elizaos.ai/)|
68
77
69
78
## CLI quick start
70
79
71
-
**Prerequisites:**[Node.js v23+](https://nodejs.org/), [bun](https://bun.sh/docs/installation). On Windows, use [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual).
80
+
**Prerequisites:**[Node.js v24+](https://nodejs.org/), [bun](https://bun.sh/docs/installation). On Windows, use [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual).
72
81
73
82
```bash
74
-
bun install -g elizaos@alpha
75
-
elizaos create my-first-agent # interactive — pick `fullstack-app` for the standard path
83
+
bun add -g elizaos
84
+
elizaos create my-first-agent --template project
76
85
cd my-first-agent
77
86
# add OPENAI_API_KEY=... to .env (or your provider's key)
78
87
bun install
79
88
bun run dev
80
89
```
81
90
82
-
The scaffolded `fullstack-app` exposes the runtime scripts you'll use day-to-day: `bun run dev`, `bun run build`, `bun run test`, `bun run typecheck`, `bun run lint`, `bun run verify`. The `elizaos` CLI itself is intentionally minimal — its job is scaffolding (`elizaos create`) and template upgrades (`elizaos upgrade`). For a list of available templates, run `elizaos info`.
91
+
The generated project exposes the runtime scripts you'll use day-to-day: `bun run dev`, `bun run build`, `bun run test`, `bun run typecheck`, `bun run lint`, `bun run verify`. The `elizaos` CLI itself is intentionally minimal — its job is scaffolding (`elizaos create`) and template upgrades (`elizaos upgrade`). For a list of available templates, run `elizaos info`.
83
92
84
93
Full reference: `elizaos --help` or `elizaos <command> --help`.
85
94
@@ -100,32 +109,34 @@ Nearly every surface has a working example in [`packages/examples/`](packages/ex
100
109
101
110
> **About the partial clone.**`--filter=blob:none` gives you the full history but fetches file contents on demand — about 10× smaller. `git log`, branches, and `git checkout` work normally; `git blame` and `git log -p` will fetch on first use. To upgrade later: `git config --unset remote.origin.partialclonefilter && git fetch --refetch`. For one-off CI, `--depth=1 --single-branch` is even smaller.
102
111
103
-
## Create a new app
112
+
## Create a new project
104
113
105
-
An *application* is a self-contained product on top of the runtime: UI, runtime plugin, metadata. Two paths:
114
+
A project is a self-contained product workspace on top of the runtime: branded
115
+
app shell, local eliza checkout, app plugin selection, platform config, and
116
+
deployment scripts. Two paths:
106
117
107
118
**1. CLI scaffold (recommended).**
108
119
109
120
```bash
110
-
elizaos create my-app -t fullstack-app
121
+
elizaos create my-app --template project
111
122
cd my-app
112
123
bun install
113
124
bun run dev
114
125
```
115
126
116
-
`fullstack-app` lays out a full workspace with a local eliza checkout, default plugins (`plugin-sql`, `plugin-elizacloud`, `plugin-local-ai`, `plugin-ollama`), and a Vite + React UI you can edit immediately.
127
+
The project template lays out a full workspace with a local eliza checkout, default plugins (`plugin-sql`, `plugin-elizacloud`, `plugin-local-ai`, `plugin-ollama`), and a Vite + React UI you can edit immediately.
117
128
118
129
**2. Copy a template directly.**[`templates/min-app/`](templates/min-app) is the smallest possible app — Vite + React UI, a runtime `Plugin` with one action, the `elizaos.app` metadata block in `package.json`, and a vitest smoke test. Read [`templates/min-app/SCAFFOLD.md`](templates/min-app/SCAFFOLD.md) for the placeholders to replace and the verification contract.
119
130
120
-
For real-world references, browse [`apps/`](apps). A few starting points by complexity:
131
+
For first-party app plugin references, browse [`plugins/app-*`](plugins). A few starting points by complexity:
121
132
122
-
-[`app-companion`](apps/app-companion) — chat-first companion with a custom React UI.
0 commit comments