From 697096f9cba62edfdeaf4e45143fa4836c5a3b2a Mon Sep 17 00:00:00 2001 From: os-warren Date: Wed, 19 Aug 2026 04:30:22 +0000 Subject: [PATCH 1/2] docs(quickstart): transcribe the os start banner from a real boot MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Part of #94 The Path A sample block is transcribed from a boot of the published @objectstack/cli 17.0.0 on an empty kernel, rather than hand-corrected: it prints one Console line (not two), an MCP line the sample lacked, and Plugins: 30 loaded (the sample said 23). The phantom Account lines are deleted rather than repointed — the real CLI prints no Account line at all. Per the landed Surface entry in resources/glossary.mdx there are two HTTP entry points, / and /_console/; account sign-in, registration and self-service are routes inside the UI. The register row in the "What's running" table is repointed to /_console/register, the two duplicate /_console/ rows are deduped with Setup taking /_console/apps/setup, and the plugin blockquote drops its exact count and is rewritten from the measured boot. --- content/docs/quickstart.mdx | 41 +++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/content/docs/quickstart.mdx b/content/docs/quickstart.mdx index 1eec30c..5d6bc51 100644 --- a/content/docs/quickstart.mdx +++ b/content/docs/quickstart.mdx @@ -10,7 +10,8 @@ There are two ways to start, depending on what you're doing. | Trying ObjectOS for the first time, or running it in production | [Path A — `os start`](#path-a--os-start-operator-first-time-evaluator) | | Building or customizing an app in code | [Path B — `os init`](#path-b--os-init-developer) | -Both produce a running server with the UI + Account. The +Both produce a running server with the UI — account sign-in, registration +and self-service are routes inside that UI, not a separate surface. The difference is whether you scaffold source files. ## Prerequisites @@ -37,28 +38,42 @@ You'll see: ◆ ObjectStack ──────────────────────────────────────── 🏠 Home: ~/.objectstack -📦 Artifact: none (empty kernel — install apps via Console marketplace) +📦 Artifact: none (empty kernel — install apps via the Console marketplace) 🗄️ Database: file:~/.objectstack/data/objectstack.db +🎯 Environment: env_local +🖥️ Console: http://localhost:3000/_console/ + → Starting server... ✓ Server is ready ➜ API: http://localhost:3000/ - ➜ Console: http://localhost:3000/_console/ - ➜ Account: http://localhost:3000/_account/ ➜ Console: http://localhost:3000/_console/ + ➜ MCP: http://localhost:3000/api/v1/mcp + connect an AI client (Claude Code, Cursor, …) · skill: http://localhost:3000/api/v1/mcp/skill - Plugins: 23 loaded + Config: objectstack.config.ts + Mode: production + Driver: SqlDriver(better-sqlite3) → ~/.objectstack/data/objectstack.db + Tenancy: single + Plugins: 30 loaded + + Press Ctrl+C to stop ``` That's it. You're running ObjectOS. +That block is transcribed from `@objectstack/cli` 17.0.0 booting an empty +kernel. Home paths show as `~/…` — the CLI prints yours expanded. Your own boot +also prints startup advisories (local storage driver, dev crypto key) and the +full list of loaded plugin names, both of which depend on your environment. + ### What's running | URL | What it is | |---|---| -| http://localhost:3000/_account/register | Create your first account | +| http://localhost:3000/_console/register | Create your first account | | http://localhost:3000/_console/ | The generated UI — and the **app marketplace** | -| http://localhost:3000/_console/ | **Setup** — users, roles, audit log, settings | +| http://localhost:3000/_console/apps/setup | **Setup** — users, roles, audit log, settings | | http://localhost:3000/api/v1/health | Liveness — is the process up | | http://localhost:3000/api/v1/ready | Readiness — is it up **and** serving data | @@ -148,8 +163,6 @@ You'll see: ✓ Server is ready ➜ API: http://localhost:3002/ - ➜ Console: http://localhost:3002/_console/ - ➜ Account: http://localhost:3002/_account/ ➜ Console: http://localhost:3002/_console/ ``` @@ -219,11 +232,13 @@ Each template is < 2500 LOC, readable in one sitting, runs standalone. ## What's loaded out of the box -Either path gives you these 23 plugins automatically: +Either path gives you these plugins automatically: -> Auth, Security (RBAC + RLS + FLS), Audit, REST API, Console UI, -> Account UI, Console UI, AI Service, Queue, Jobs, Cache, Settings, -> Email, Storage, Marketplace, Metadata, ObjectQL, plus the SQL driver. +> HTTP server, REST API, Dispatcher, MCP server, Auth, Security (RBAC + RLS + +> FLS), Audit, Sharing, Platform objects, Metadata, ObjectQL, the default +> datasource plus the external-datasource and datasource-admin services, Queue, +> Jobs, Cache, Settings, Email, SMS, Messaging, Storage, Analytics, external +> validation, Marketplace, the Setup and Account apps, and the Console UI. You don't import or wire any of them — they activate when something declares it needs them. From 7a8e2be2287a65219c7db23d2674b943a8da3f1a Mon Sep 17 00:00:00 2001 From: os-warren Date: Wed, 19 Aug 2026 04:41:41 +0000 Subject: [PATCH 2/2] docs(quickstart): warn that Path B does not compile on the published CLI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Part of #94 On @objectstack/cli 17.0.0 — the currently published latest — the scaffold os init generates declares no sharingModel and is rejected by the CLI's own security-owd-unset author-time rule, so pnpm dev exits 1 before a dev server exists. The fix is merged upstream and awaiting a release. The caveat is pinned to the published version the same way the Path A transcription note is, so it is checkable rather than open-ended. Path B's sample block is deliberately left as-is: it stays unmeasured until a fixed CLI publishes and it can be transcribed from a real boot. --- content/docs/quickstart.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/docs/quickstart.mdx b/content/docs/quickstart.mdx index 5d6bc51..c2d8344 100644 --- a/content/docs/quickstart.mdx +++ b/content/docs/quickstart.mdx @@ -150,6 +150,14 @@ cd my-app pnpm dev ``` +> **Warning:** On `@objectstack/cli` 17.0.0 — the currently published +> `latest` — this sequence does not reach a dev server. The project +> `init` scaffolds declares no `sharingModel`, which the CLI's own +> `security-owd-unset` author-time rule rejects, so `pnpm dev` exits 1 +> during compile instead of starting. The fix is merged and awaiting a +> release — +> [objectstack#9666](https://github.com/objectstack-ai/objectstack/issues/9666). + You'll see: ```text