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
docs: reposition ObjectStack vs ObjectOS + retire 'ObjectOS' as the control-layer name (#2955)
* docs: reposition ObjectStack (open-source framework + runtime) vs ObjectOS (commercial runtime environment)
- README: ObjectStack ships its own production runtime (os start / the
official Docker image ghcr.io/objectstack-ai/objectstack) — building,
running, and self-hosting your own apps is fully open source. ObjectOS
is the separate commercial runtime environment for end-user
organizations (Cloud & Enterprise). Drop links to the community
objectos repo; disambiguate the ObjectOS protocol layer from the
ObjectOS product.
- LICENSING: spell out that the production runtime and Docker image
definition are Apache-2.0 with no dev/prod feature gate; ObjectOS
editions are commercial and live outside this repo.
- docs: unify the hosted-product brand 'ObjectStack Cloud' → 'ObjectOS
Cloud' on current pages (historical release notes left untouched).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG
* docs: strip feature-level commercial mentions from open docs
Product-level boundary statements (README/LICENSING) stay; feature-level
docs now state open-source behavior only, without advertising what the
commercial distribution contains:
- drivers/environment-variables: 'libsql:// (Turso) is not supported' —
drop the commercial-distribution packaging details.
- environment-variables OS_CLUSTER_DRIVER: the claim that non-memory
cluster drivers 'ship in the EE distribution' was also outdated —
@objectstack/service-cluster-redis is an open, npm-published sibling
package in this repo (kernel/cluster Phase 3 ✅). Point to it instead.
- implementation-status: drop the internal cloud ADR citation; keep the
open-boundary explanation (schemas open, BYO-AI via @objectstack/mcp).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG
* docs(ai): replace 'cloud / Enterprise' packaging talk with ObjectOS product boundary
Same rule as the previous commit, applied to the AI docs area where the
pattern was systemic (agents, index, actions-as-tools, knowledge-rag,
natural-language-queries, protocol/knowledge, environment-variables):
- Brand: 'cloud / Enterprise tier/distribution/runtime' → ObjectOS.
- Drop links/citations to the private cloud repo's ADR-0025 (404 for the
public) and @objectstack/service-ai packaging internals, including the
AIServicePlugin constructor walkthrough — commercial runtime config now
points to the ObjectOS docs instead.
- Boundary statements themselves stay: schemas/authoring open, in-product
chat runtime ships in ObjectOS, open path is @objectstack/mcp (BYO-AI).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG
* docs: finish sweeping commercial packaging mentions from open docs
Remaining 'Cloud / Enterprise' callouts and @objectstack/service-ai
internals (approval-queue plugin config, chat-route internals, the
implementation-status AI matrix listing closed-source file names, the
knowledge-protocol diagram box) now state the ObjectOS product boundary
only, pointing to the ObjectOS docs for its configuration.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG
* docs: retire 'ObjectOS' as the control-layer name — the layer is now 'Kernel'
ObjectOS now exclusively names the commercial runtime environment, so
using it as the open spec's control-layer brand was a permanent naming
collision (papered over by a disambiguation note until now).
- Layer naming: ObjectQL (data) / Kernel (control) / ObjectUI (view).
ObjectQL and ObjectUI stay — they name real open technologies; only
the layer-brand use of ObjectOS is retired.
- README: layer list + layers alt-text; drop the now-unneeded naming
note. ARCHITECTURE.md: layer diagram/table.
- concepts/architecture.mdx, protocol/index card, protocol/diagram,
glossary (with an explicit migration note), implementation-status,
permissions/automation/plugins/getting-started prose: layer actor
renamed to Kernel / ObjectStack runtime as fits.
- protocol/objectos/ pages: landing page retitled 'Kernel: The System
Protocol'; behavior narratives now use ObjectStack as the actor.
Directory/URL rename to protocol/kernel deferred (needs redirects).
- skills/objectstack-platform + spec prompts aligned.
Follow-ups (not in this PR): regenerate docs/screenshots/layers.png;
sweep the ~43 ObjectOS mentions in packages/spec source TSDoc/strings
(feeds the auto-generated references/ docs); move
content/docs/protocol/objectos/ → protocol/kernel/ with redirects.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG
* chore: add patch changeset for spec prompts layer-naming change
packages/spec publishes prompts/ in the npm package, so the layer-naming
alignment there is a published-content change.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162o68e5w3bpUBEVRQboUGG
---------
Co-authored-by: Claude <noreply@anthropic.com>
Retire "ObjectOS" as the control-layer name in the published agent prompts (`prompts/`): the open control layer is now called the **Kernel**; **ObjectOS** exclusively names the commercial runtime environment. Layer vocabulary is now ObjectQL (data) / Kernel (control) / ObjectUI (view). Prompt text only — no schema changes.
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,11 @@
8
8
> **A metadata protocol and TypeScript toolkit for AI-native business apps.** Describe your objects, permissions, workflows, APIs, UI, and AI tools once as typed, version-controlled Zod metadata — and ObjectStack derives the TypeScript types, REST API, client SDK, UI, and MCP tools from that single definition.
9
9
10
10
```
11
-
ObjectStack (this repo) → how a business app is described — the protocol + toolkit
12
-
ObjectOS → where it runs, and where AI plugs in — the runtime
11
+
ObjectStack (this repo) → for builders — the open-source protocol, toolkit, and production runtime
12
+
ObjectOS → for end users — the commercial runtime environment (Cloud & Enterprise)
13
13
```
14
14
15
-
This repo is the **framework**: the protocol, kernel, SDK, and CLI you build with. To *run* apps and let AI operate them under your permissions, deploy on **[ObjectOS](https://github.com/objectstack-ai/objectos)**. · Try a live app in ~30s on [StackBlitz](https://stackblitz.com/github/objectstack-ai/hotcrm) (no install).
15
+
This repo is the **framework**: the protocol, kernel, SDK, CLI, and production runtime you build — and ship — with. `os start` or the official Docker image [`ghcr.io/objectstack-ai/objectstack`](./docker) runs your compiled app in production, Console and governance included, entirely on open source. For a managed, organization-scale runtime environment (multi-environment control plane, provisioning, marketplace), deploy to **[ObjectOS](https://docs.objectos.ai)** — the commercial Cloud & Enterprise product. · Try a live app in ~30s on [StackBlitz](https://stackblitz.com/github/objectstack-ai/hotcrm) (no install).
16
16
17
17
<palign="center">
18
18
<imgsrc="docs/screenshots/architecture.png"width="940"alt="ObjectStack architecture: author typed Zod metadata (objects, flows, views, policies); the microkernel compiles it into a versioned JSON artifact and loads plugins, drivers, and services; it generates a REST API, client SDK, Console and Studio UI, and MCP tools used by developers and AI agents, governed by Auth, RBAC, RLS, FLS, and audit, over PostgreSQL, MySQL, SQLite, or MongoDB">
@@ -21,7 +21,7 @@ This repo is the **framework**: the protocol, kernel, SDK, and CLI you build wit
21
21
22
22
## What is ObjectStack?
23
23
24
-
ObjectStack is an **open-source** metadata protocol and toolkit for *describing* business applications — so one typed definition powers your data model, API, UI, and AI tools. Apps run, and AI operates them under your permissions, on the [ObjectOS](https://github.com/objectstack-ai/objectos)runtime.
24
+
ObjectStack is an **open-source**(Apache-2.0) metadata protocol and toolkit for *describing* business applications — so one typed definition powers your data model, API, UI, and AI tools — plus the production runtime that serves them. AI operates your app under your permissions through the built-in MCP server. **[ObjectOS](https://docs.objectos.ai)** is the separate, commercial runtime environment that operates ObjectStack apps for end-user organizations (Cloud & Enterprise editions).
25
25
26
26
Instead of hiding business logic inside ad-hoc SQL queries, UI state, or JavaScript strings, ObjectStack makes the business system explicit:
27
27
@@ -30,12 +30,12 @@ Instead of hiding business logic inside ad-hoc SQL queries, UI state, or JavaScr
30
30
-**Business logic** is represented as analyzable metadata: flows, conditions, policies, and artifacts.
31
31
-**Business runtime** is a microkernel that loads plugins, drivers, services, and compiled environment artifacts.
32
32
33
-
The goal is not to be another low-code UI builder. ObjectStack is the structured *definition* layer for AI-native business software — agent-ready, versioned, and analyzable; permissions and audit are enforced at runtime by ObjectOS.
33
+
The goal is not to be another low-code UI builder. ObjectStack is the structured *definition* layer for AI-native business software — agent-ready, versioned, and analyzable; permissions and audit are enforced by the runtime.
34
34
35
-
ObjectStack is built around three protocol layers:
35
+
ObjectStack is built around three layers:
36
36
37
37
-**ObjectQL** (Data Layer) — Objects, fields, queries, relations, validation, and data access.
All core definitions start with **Zod schemas** (1,600+ exported schemas across 200 schema files). TypeScript types, JSON Schemas, REST routes, UI metadata, and agent tools are derived from the same source of truth.
@@ -77,7 +77,7 @@ Prefer clicking? Author the same metadata visually in **Studio** — objects, re
77
77
</p>
78
78
<palign="center"><sub><b>Model</b> objects as typed metadata · <b>Automate</b> with visual flows — both produce the same analyzable metadata.</sub></p>
79
79
80
-
> **Want to see it running?**Deploy on **[ObjectOS](https://github.com/objectstack-ai/objectos)** for the live Console — dashboards, boards, calendars, records, and AI working your data under your permissions.
80
+
> **Want to see it running?**`os dev` serves the live Console locally, and `os start` (or the official Docker image) ships the same Console to production — dashboards, boards, calendars, records, and AI working your data under your permissions.
81
81
82
82
## Key Features
83
83
@@ -105,7 +105,7 @@ The point isn't lines of code. The point is **fit in an agent's context window.*
105
105
| AI maintainability | Agents must crawl sprawling app code | Whole app fits in an agent's context window |
Described in ObjectStack and deployed on [ObjectOS](https://github.com/objectstack-ai/objectos), this is the substrate for AI-native business apps — CRM, support, operations, and workflow agents acting on real business data without bypassing permissions or audit.
108
+
Described in ObjectStack and served by its runtime, this is the substrate for AI-native business apps — CRM, support, operations, and workflow agents acting on real business data without bypassing permissions or audit.
109
109
110
110
## Quick Start
111
111
@@ -288,10 +288,10 @@ For the browser, the typed client SDK and React hooks (`useQuery` / `useMutation
288
288
289
289
## Architecture
290
290
291
-
ObjectStack uses a **microkernel architecture** where the kernel provides only the essential infrastructure (DI, EventBus, lifecycle), and all capabilities are delivered as plugins. The three protocol layers sit above the kernel:
291
+
ObjectStack uses a **microkernel architecture** where the kernel provides only the essential infrastructure (DI, EventBus, lifecycle), and all capabilities are delivered as plugins. The three layers sit above the microkernel:
292
292
293
293
<palign="center">
294
-
<imgsrc="docs/screenshots/layers.png"width="900"alt="ObjectStack layered architecture: the ObjectQL data layer, ObjectOS control layer, and ObjectUI view layer sit on a microkernel (plugin lifecycle, service registry / DI, event bus); every capability — drivers, server, auth, security, automation, AI — is a plugin">
294
+
<imgsrc="docs/screenshots/layers.png"width="900"alt="ObjectStack layered architecture: the ObjectQL data layer, the kernel control layer, and the ObjectUI view layer sit on a microkernel (plugin lifecycle, service registry / DI, event bus); every capability — drivers, server, auth, security, automation, AI — is a plugin">
295
295
</p>
296
296
297
297
See [ARCHITECTURE.md](./ARCHITECTURE.md) for the complete design documentation including the plugin lifecycle state machine, dependency graph, and design decisions.
0 commit comments