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
{{ message }}
Repository navigation
Commit 20e79bc
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+18-23Lines changed: 18 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,19 +16,19 @@ Instead of hiding business logic inside ad-hoc SQL queries, UI state, or JavaScr
16
16
-**Business objects** are Zod schemas with typed fields, relations, validation, and permissions.
17
17
-**Business actions** are generated from metadata as REST APIs, SDK calls, and MCP tools.
18
18
-**Business logic** is represented as analyzable metadata: flows, conditions, policies, and artifacts.
19
-
-**Business runtime** is a microkernel that loads plugins, drivers, services, and compiled project artifacts.
19
+
-**Business runtime** is a microkernel that loads plugins, drivers, services, and compiled environment artifacts.
20
20
21
21
The goal is not to be another low-code UI builder. ObjectStack is the structured execution layer for AI-native business software: agent-ready, permission-aware, versioned, and auditable.
22
22
23
23
ObjectStack is built around three protocol layers:
24
24
25
25
-**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.
30
30
31
-
See [ARCHITECTURE.md](./ARCHITECTURE.md) for the full microkernel and layer architecture documentation, and [content/docs/concepts/north-star.mdx](./content/docs/concepts/north-star.mdx) for the product north star (Studio · Org/Project/Branch · per-project ObjectOS · compiled app artifacts).
31
+
See [ARCHITECTURE.md](./ARCHITECTURE.md) for the full microkernel and layer architecture documentation, and [content/docs/concepts/north-star.mdx](./content/docs/concepts/north-star.mdx) for the product north star (metadata protocols · environment-aware runtime · compiled app artifacts).
32
32
33
33
## Key Features
34
34
@@ -45,8 +45,8 @@ See [ARCHITECTURE.md](./ARCHITECTURE.md) for the full microkernel and layer arch
-**Automation engine** — DAG-based flows, triggers, and workflow management.
47
47
-**AI service** — Agent, Tool, and Skill protocol built on the Vercel AI SDK.
48
-
-**Studio IDE** — Web-based metadata explorer, schema inspector, API console, and AI assistant.
49
-
-**CLI toolchain** — `os init`, `os dev`, `os studio`, `os serve`, `os validate`, and more.
48
+
-**Console UI** — Published ObjectUI console bundle for metadata exploration, schema inspection, API testing, and administration.
49
+
-**CLI toolchain** — `os init`, `os dev`, `os start`, `os serve`, `os validate`, and more.
50
50
51
51
## Why AI-native?
52
52
@@ -63,7 +63,7 @@ The point isn't lines of code. The point is **fit in an agent's context window.*
63
63
| Business model | Implicit in pages, queries, and scripts | Explicit Zod `ObjectSchema` metadata |
64
64
| Code footprint | Thousands of lines of queries, JS, and UI state per app |**~100× less** — declarative metadata replaces CRUD, forms, validation, and API glue |
65
65
| Business logic | JavaScript snippets and query glue | Flows, policies, conditions, and typed metadata |
| Agent tools | Manually defined one by one | Generated from metadata and permissions |
68
68
| Agent reasoning | Calls predefined queries | Reads the full schema, composes safe actions, respects boundaries |
69
69
| AI maintainability | Agents must crawl sprawling app code | Whole app fits in an agent's context window |
@@ -80,10 +80,10 @@ This makes ObjectStack a backend substrate for AI-native business applications:
80
80
npx create-objectstack my-app
81
81
cd my-app
82
82
83
-
# Start dev server (REST API + Studio IDE)
83
+
# Start dev server (REST API + console UI)
84
84
pnpm dev
85
85
# → API: http://localhost:3000/api/v1/
86
-
# → Studio: http://localhost:3000/_studio/
86
+
# → Console: http://localhost:3000/_console/
87
87
```
88
88
89
89
Alternatively, with the CLI installed: `os init my-app && cd my-app && os dev`.
@@ -116,7 +116,7 @@ pnpm docs:dev
116
116
|`pnpm dev:showcase`| Same as `pnpm dev` (explicit alias) |
117
117
|`pnpm dev:crm`| Run the minimal CRM example (`@objectstack/example-crm`) |
118
118
|`pnpm dev:todo`| Run the Todo example (`@example/app-todo`) |
119
-
|`pnpm studio:start`|Start the prebuilt Studio IDE|
119
+
|`pnpm objectui:refresh`|Pull the sibling `../objectui` build into `packages/console/`|
120
120
|`pnpm test`| Run all tests (Turborepo) |
121
121
|`pnpm setup`| Install dependencies and build the spec package |
122
122
|`pnpm docs:dev`| Start the documentation site locally |
@@ -129,11 +129,10 @@ The CLI binary ships as both `os` and `objectstack`.
129
129
```bash
130
130
os init [name] # Scaffold a new project
131
131
os create # Interactive project / object scaffolder
132
-
os dev # Start dev server with hot-reload (REST + Studio)
133
-
os studio # Open the Studio IDE
132
+
os dev # Start dev server with hot-reload (REST + console)
134
133
os start # Start the production server
135
134
os serve # Serve a compiled artifact
136
-
os compile # Build a deployable JSON Project Artifact
135
+
os compile # Build a deployable JSON Environment Artifact
137
136
os validate # Validate metadata against the protocol
138
137
os lint # Lint metadata for best-practice violations
139
138
os info # Display project metadata summary
@@ -142,7 +141,7 @@ os doctor # Check environment health
142
141
os explain # Explain protocol concepts on the command line
143
142
```
144
143
145
-
Cloud, package registry, and project management subcommands (`os projects`, `os publish`, `os login`, `os whoami`, `os cloud …`) are available when targeting an ObjectStack Cloud control plane.
144
+
Cloud, package registry, and environment management subcommands (`os publish`, `os rollback`, `os package`, `os login`, `os whoami`, `os cloud …`) are available when targeting an ObjectStack Cloud control plane.
|[`objectstack-vscode`](packages/vscode-objectstack)| VS Code extension — autocomplete, validation, diagnostics |
239
-
|[`@objectstack/studio`](apps/studio)| Studio IDE — metadata explorer, schema inspector, AI assistant |
240
237
|[`@object-ui/console`](https://github.com/objectstack-ai/objectui/tree/main/apps/console)| Fork-ready runtime console SPA (lives in objectstack-ai/objectui, served via `@object-ui/console` on npm) |
@@ -300,9 +297,7 @@ See [ARCHITECTURE.md](./ARCHITECTURE.md) for the complete design documentation i
300
297
301
298
## Roadmap
302
299
303
-
See [ROADMAP.md](./ROADMAP.md) for the planned phases covering runtime hardening, framework adapter completion, developer experience improvements, performance optimization, and security hardening.
0 commit comments