|
1 | 1 | # ObjectOS |
2 | 2 |
|
3 | | -> **The business platform AI can actually use — running in your own environment.** |
4 | | -> |
5 | | -> ObjectOS is the AI-native runtime for [ObjectStack](https://github.com/objectstack-ai/framework) |
6 | | -> applications. Put your business systems — CRM, contracts, tickets, |
7 | | -> approvals, anything modeled in ObjectStack metadata — on ObjectOS, and |
8 | | -> AI agents can safely query, analyze, and act on that data under your |
9 | | -> permissions, on your servers, with every step audited. |
10 | | -
|
11 | | -**ObjectStack** is a metadata protocol for describing business |
12 | | -applications — objects, permissions, workflows, APIs, UI, and AI tools — |
13 | | -in one structured definition. |
14 | | -**ObjectOS** is where those applications run, and where AI plugs in. |
| 3 | +> **The official runtime environment for ObjectStack applications** — operated |
| 4 | +> for end-user organizations as **ObjectOS Cloud** (managed) and |
| 5 | +> **ObjectOS Enterprise** (self-managed). |
15 | 6 |
|
16 | | -``` |
17 | | -ObjectStack → how a business application is described |
18 | | -ObjectOS → where it runs, and where AI plugs in |
19 | | -``` |
| 7 | +ObjectOS is a **commercial product**. This repository is its public home: |
20 | 8 |
|
21 | | -## See it running |
22 | | - |
23 | | -ObjectStack metadata, running on ObjectOS — the business apps your team actually uses, with AI working the same data under the same permissions. |
24 | | - |
25 | | -<p align="center"> |
26 | | - <img src="docs/screenshots/dashboard.png" width="900" alt="A business application running on ObjectOS: an executive dashboard with revenue, account, and pipeline KPIs plus charts"> |
27 | | - <br><sub>A business app running on ObjectOS — dashboards, KPIs, and reports over data you host.</sub> |
28 | | -</p> |
29 | | - |
30 | | -<p align="center"> |
31 | | - <img src="docs/screenshots/kanban.png" width="49%" alt="Pipeline as a kanban board"> |
32 | | - <img src="docs/screenshots/gantt.png" width="49%" alt="Delivery plan as a Gantt schedule"> |
33 | | -</p> |
34 | | -<p align="center"> |
35 | | - <img src="docs/screenshots/calendar.png" width="49%" alt="Records on a calendar"> |
36 | | - <img src="docs/screenshots/gallery.png" width="49%" alt="Records as a cover gallery"> |
37 | | -</p> |
38 | | -<p align="center"><sub>The same records as boards, Gantt schedules, calendars, and galleries — rendered by the runtime from metadata, no extra UI code.</sub></p> |
39 | | - |
40 | | -<p align="center"> |
41 | | - <img src="docs/screenshots/record.png" width="49%" alt="A record page with a guided stage path and actions"> |
42 | | - <img src="docs/screenshots/ask-ai.png" width="49%" alt="AI assistant querying business records"> |
43 | | -</p> |
44 | | -<p align="center"><sub><b>Rich records</b> with guided actions, and <b>AI plugged into the same data</b> — agents act as the signed-in user, every step audited.</sub></p> |
45 | | - |
46 | | -## Why ObjectOS |
47 | | - |
48 | | -The promise of "AI inside the enterprise" usually breaks on two things: |
49 | | -AI can't actually use the business system, and security can't say yes |
50 | | -to letting it try. ObjectOS removes both blockers: |
51 | | - |
52 | | -- **Every object is an AI tool, automatically.** Define a business |
53 | | - object once in ObjectStack metadata; ObjectOS exposes it to AI agents |
54 | | - as a governed, callable tool — no glue code, no separate integration |
55 | | - layer to maintain. |
56 | | -- **AI acts as the signed-in user.** Whatever that person is allowed to |
57 | | - see or do, the agent can — nothing more. The boundary is enforced in |
58 | | - the runtime, not in the prompt. |
59 | | -- **One audit log for humans and agents.** Every read, write, and |
60 | | - escalation — by a person or an AI — is recorded with who, what, when, |
61 | | - and why. Compliance gets one log to look at, not two. |
62 | | -- **Permissions enforced at the runtime.** Role-based access, |
63 | | - record-level rules, and field-level redaction run inside ObjectOS, so |
64 | | - the same policy applies whether the call comes from the UI, an API |
65 | | - client, or an agent. |
66 | | -- **Your data, your network.** Runs in your environment — private cloud, |
67 | | - on-prem, or fully air-gapped. Business data and AI prompts stay |
68 | | - inside your perimeter; no third party in the loop. |
69 | | -- **Plugs into the identity you already operate.** OAuth, OIDC, SAML, |
70 | | - corporate SSO, or local accounts. AI sessions inherit the same |
71 | | - identity, MFA, and offboarding — no separate "AI account" to govern. |
72 | | - |
73 | | -## Positioning |
74 | | - |
75 | | -| | ObjectStack framework | **ObjectOS** | Plugins | |
76 | | -|---|---|---|---| |
77 | | -| Role | The protocol — *how* an application is described | The runtime — *where* it runs and where AI plugs in | Anyone-can-write extensions on top of the runtime | |
78 | | -| Repo | `objectstack-ai/framework` | `objectstack-ai/objectos` | Any repo publishing `@objectos/plugin-*` (or your own scope) | |
79 | | -| What it ships | Protocol, kernel, `@objectstack/*` packages, Console, control plane | Runtime distribution + Docker/Helm + ops docs | Drivers, identity providers, audit exporters, custom UI, AI tools, integrations — your call | |
80 | | -| Who builds it | Framework contributors | Distribution maintainers | **Anyone** — community, vendors, your own team | |
81 | | -| License | Apache-2.0 | **Apache-2.0** | Author's choice (Apache-2.0, MIT, commercial, internal-only) | |
82 | | -| Release cadence | Frequent (per `changeset`) | Distribution semver (e.g. `2026.05 LTS`) | Independent — plugins version themselves | |
83 | | - |
84 | | -Plugins are first-class: ObjectOS exposes the same extension points the |
85 | | -core uses. See [`packages/`](packages/) for reference plugins, and the |
86 | | -[plugin authoring guide](content/docs/extend/plugins.mdx) to publish |
87 | | -your own. |
88 | | - |
89 | | -## Boot modes |
90 | | - |
91 | | -ObjectOS boots in one of two modes, selected by environment variables: |
92 | | - |
93 | | -| Mode | Required env | Use case | |
94 | | -|---|---|---| |
95 | | -| **Cloud-connected** | `OS_CLOUD_URL`, `OS_PROJECT_ID` | Production with the ObjectStack control plane / Console | |
96 | | -| **Offline / air-gapped** | `OS_ARTIFACT_FILE` | Compile locally with the CLI, ship the JSON artifact, run anywhere | |
97 | | - |
98 | | -See [`apps/objectos/objectstack.config.ts`](apps/objectos/objectstack.config.ts). |
99 | | - |
100 | | -## Quick start |
| 9 | +- 📚 **Documentation** — source for [docs.objectos.ai](https://docs.objectos.ai) |
| 10 | + (`content/docs/`, built by `apps/docs/`), in seven languages. |
| 11 | +- 🐛 **Issue tracker** — bug reports and feature requests for ObjectOS Cloud |
| 12 | + and ObjectOS Enterprise. |
| 13 | +- ™️ **Trademark policy** — [TRADEMARK.md](TRADEMARK.md). The "ObjectOS" name |
| 14 | + and logo are trademarks and are not covered by the code license. |
101 | 15 |
|
102 | | -```bash |
103 | | -pnpm install |
| 16 | +The product source is developed privately and is not published in this |
| 17 | +repository. There is no open-source edition of ObjectOS. |
104 | 18 |
|
105 | | -# Build the runtime distribution and docs |
106 | | -pnpm build |
| 19 | +## Editions |
107 | 20 |
|
108 | | -# Boot the runtime against a local compiled artifact |
109 | | -cd apps/objectos |
110 | | -OS_ARTIFACT_FILE=dist/objectstack.json PORT=3200 pnpm start |
| 21 | +| Edition | Delivery | For | |
| 22 | +|:---|:---|:---| |
| 23 | +| **ObjectOS Cloud** | Managed service | Organizations that want the platform operated for them — orgs, environments, deploys, billing. | |
| 24 | +| **ObjectOS Enterprise** | Self-managed deployment | Organizations that run the platform on their own infrastructure. | |
111 | 25 |
|
112 | | -# Or run the documentation site |
113 | | -pnpm docs:dev |
114 | | -``` |
| 26 | +See [docs.objectos.ai](https://docs.objectos.ai) for capabilities, deployment, |
| 27 | +and operations documentation. |
115 | 28 |
|
116 | | -### Docker |
| 29 | +## Building and running your own apps? That's ObjectStack — and it's open source |
| 30 | + |
| 31 | +Everything you need to **build, run, and self-host your own applications** is |
| 32 | +the open-source (Apache-2.0) **[ObjectStack framework](https://github.com/objectstack-ai/framework)**: |
117 | 33 |
|
118 | | -```bash |
119 | | -mkdir -p docker/artifacts |
120 | | -cp apps/objectos/dist/objectstack.json docker/artifacts/objectstack.json |
121 | | -docker compose -f docker/docker-compose.yml up --build |
| 34 | +``` |
| 35 | +ObjectStack → for builders — the open-source protocol, toolkit, and production runtime |
| 36 | +ObjectOS → for end users — the commercial runtime environment (Cloud & Enterprise) |
122 | 37 | ``` |
123 | 38 |
|
124 | | -Docker Compose publishes ObjectOS on `http://localhost:3000` by default. |
125 | | -Use `OBJECTOS_PORT=3200` to change the host port. |
| 39 | +`os start` — or the official Docker image |
| 40 | +[`ghcr.io/objectstack-ai/objectstack`](https://github.com/objectstack-ai/framework/tree/main/docker) — |
| 41 | +serves your compiled app in production with the Console, permissions, and |
| 42 | +audit included. No commercial license required. |
126 | 43 |
|
127 | | -## Repository layout |
| 44 | +## What happened to the code that used to live here? |
128 | 45 |
|
129 | | -``` |
130 | | -objectos/ |
131 | | -├── apps/ |
132 | | -│ ├── objectos/ # Runtime entry — single objectstack.config.ts |
133 | | -│ └── docs/ # Product / operations site (Fumadocs + Next.js) |
134 | | -├── packages/ # Plugins (@objectos/plugin-*) — anyone can write one |
135 | | -├── content/docs/ # MDX content powering apps/docs |
136 | | -├── docker/ # Dockerfile + docker-compose |
137 | | -├── helm/ # Helm chart (planned) |
138 | | -├── examples/ # Reference deployments |
139 | | -├── e2e/ # Black-box smoke tests against the published image |
140 | | -└── scripts/ |
141 | | -``` |
| 46 | +Until July 2026 this repository contained a free reference runtime |
| 47 | +distribution (`@objectos/server`) and a desktop build (**ObjectOS One**). |
| 48 | +As part of clarifying the ObjectStack / ObjectOS split: |
142 | 49 |
|
143 | | -## Documentation |
| 50 | +- **`@objectos/server` is superseded** by the official ObjectStack runtime |
| 51 | + image (`ghcr.io/objectstack-ai/objectstack`) — the same capability, |
| 52 | + maintained where the runtime itself lives. |
| 53 | +- **ObjectOS One is discontinued.** Demos and evaluations are served by the |
| 54 | + official Docker image and ObjectOS Cloud trials. |
| 55 | +- **Everything already released stays licensed as released**: historical |
| 56 | + source remains available under Apache-2.0 in this repository's git history |
| 57 | + (archive tag: `archive/apache-final`). Nothing is retroactively withdrawn. |
144 | 58 |
|
145 | | -- [Quickstart](content/docs/quickstart.mdx) |
146 | | -- [Architecture](content/docs/architecture.mdx) |
147 | | -- [Deployment](content/docs/deploy/index.mdx) — Docker, Kubernetes, air-gapped |
148 | | -- [Authentication](content/docs/configure/authentication.mdx) |
149 | | -- [Permissions](content/docs/configure/permissions.mdx) |
150 | | -- [Observability](content/docs/operate/observability.mdx) |
| 59 | +## Working on the docs |
151 | 60 |
|
152 | | -## History |
| 61 | +```bash |
| 62 | +pnpm install |
| 63 | +pnpm docs:dev # Fumadocs site at http://localhost:3000 |
| 64 | +``` |
153 | 65 |
|
154 | | -The current `main` is a deliberate restart aligned with the |
155 | | -[ObjectStack North Star](https://github.com/objectstack-ai/framework/blob/main/content/docs/concepts/north-star.mdx). |
| 66 | +Documentation is authored **English-first**; other locales are derived |
| 67 | +translations (see [AGENTS.md](AGENTS.md)). Contributions are welcome — |
| 68 | +see [CONTRIBUTING.md](CONTRIBUTING.md). |
156 | 69 |
|
157 | 70 | ## License |
158 | 71 |
|
159 | | -ObjectOS is licensed under the [Apache License 2.0](LICENSE). |
| 72 | +The contents of this repository (documentation and site code) are licensed |
| 73 | +under the [Apache License 2.0](LICENSE). |
160 | 74 |
|
161 | | -"ObjectOS" and the ObjectOS logo are trademarks of the ObjectOS project |
162 | | -and are not covered by the Apache 2.0 grant. See [TRADEMARK.md](TRADEMARK.md). |
| 75 | +"ObjectOS" and the ObjectOS logo are trademarks of the ObjectOS project and |
| 76 | +are not covered by the Apache 2.0 grant. See [TRADEMARK.md](TRADEMARK.md). |
0 commit comments