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
+51-27Lines changed: 51 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ ObjectStack is built around three protocol layers:
28
28
29
29
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.
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).
32
32
33
33
## Key Features
34
34
@@ -70,18 +70,17 @@ This makes ObjectStack a backend substrate for AI-native business applications:
70
70
71
71
```bash
72
72
# Create a new project
73
-
npx @objectstack/cli init my-app
73
+
npx create-objectstack my-app
74
74
cd my-app
75
75
76
-
# Start development server
77
-
os dev
78
-
79
-
# Open Studio IDE
80
-
os studio
76
+
# Start dev server (REST API + Studio IDE)
77
+
pnpm dev
81
78
# → API: http://localhost:3000/api/v1/
82
79
# → Studio: http://localhost:3000/_studio/
83
80
```
84
81
82
+
Alternatively, with the CLI installed: `os init my-app && cd my-app && os dev`.
83
+
85
84
### For Framework Contributors
86
85
87
86
```bash
@@ -106,28 +105,38 @@ pnpm docs:dev
106
105
| Script | Description |
107
106
| :--- | :--- |
108
107
|`pnpm build`| Build all packages (excludes docs) |
109
-
|`pnpm dev`| Start development server |
110
-
|`pnpm studio`| Launch Studio IDE with dev server |
111
-
|`pnpm test`| Run all tests |
108
+
|`pnpm dev`| Run the reference `@objectstack/objectos` host in dev mode |
109
+
|`pnpm dev:cloud`| Run `@objectstack/cloud` (multi-project, control-plane mode) |
110
+
|`pnpm dev:crm`| Run the CRM example end-to-end (`@example/app-crm`) |
111
+
|`pnpm studio:start`| Start the prebuilt Studio IDE |
112
+
|`pnpm test`| Run all tests (Turborepo) |
112
113
|`pnpm doctor`| Check environment health |
113
-
|`pnpm setup`| Install dependencies and build spec |
114
-
|`pnpm docs:dev`| Start documentation site locally |
114
+
|`pnpm setup`| Install dependencies and build the spec package|
115
+
|`pnpm docs:dev`| Start the documentation site locally |
115
116
|`pnpm docs:build`| Build documentation for production |
116
117
117
118
## CLI Commands
118
119
120
+
The CLI binary ships as both `os` and `objectstack`.
121
+
119
122
```bash
120
123
os init [name] # Scaffold a new project
121
-
os dev # Start dev server with hot-reload
122
-
os studio # Start dev server + Studio IDE
123
-
os serve # Start production server
124
-
os compile # Build deployable JSON artifact
125
-
os validate # Validate configuration against protocol
126
-
os info # Display metadata summary
127
-
os generate # Scaffold objects, views, and flows
124
+
os create # Interactive project / object scaffolder
125
+
os dev # Start dev server with hot-reload (REST + Studio)
126
+
os studio # Open the Studio IDE
127
+
os start # Start the production server
128
+
os serve # Serve a compiled artifact
129
+
os compile # Build a deployable JSON Project Artifact
130
+
os validate # Validate metadata against the protocol
131
+
os lint # Lint metadata for best-practice violations
132
+
os info # Display project metadata summary
133
+
os generate # Scaffold objects, views, flows, agents, migrations
128
134
os doctor # Check environment health
135
+
os explain # Explain protocol concepts on the command line
129
136
```
130
137
138
+
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.
139
+
131
140
## Package Directory
132
141
133
142
### Core
@@ -137,6 +146,8 @@ os doctor # Check environment health
0 commit comments