unoverse 0.1.28 → 0.1.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -9
- package/operator/skills/unoverse-create/SKILL.md +11 -11
- package/operator/skills/unoverse-create/references/agent-skill.md +1 -1
- package/operator/skills/unoverse-create/references/component.md +2 -2
- package/operator/skills/unoverse-create/references/node.md +3 -3
- package/operator/skills/unoverse-create/references/template.md +1 -1
- package/operator/skills/unoverse-create/references/workflow.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,19 +1,35 @@
|
|
|
1
1
|
# unoverse
|
|
2
2
|
|
|
3
|
-
The Unoverse front door.
|
|
3
|
+
The Unoverse front door. Build agent-powered apps: interfaces as data, workflows
|
|
4
|
+
on a canvas, agent skills in plain markdown.
|
|
4
5
|
|
|
5
6
|
```bash
|
|
6
|
-
npm
|
|
7
|
+
npm install -g unoverse
|
|
8
|
+
unoverse create # asks what you're building, then sets it up
|
|
7
9
|
```
|
|
8
10
|
|
|
9
|
-
- **
|
|
10
|
-
|
|
11
|
-
- **
|
|
12
|
-
|
|
13
|
-
- **
|
|
11
|
+
- **Studio** — author components, templates, nodes, and agent skills. Most
|
|
12
|
+
people start (and stay) here.
|
|
13
|
+
- **Universe** — run the platform yourself, on your own infrastructure. Needs a
|
|
14
|
+
registry access token from your Unoverse admin.
|
|
15
|
+
- **Client** — a client accelerator that talks to unoverse.
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
Standing in a universe folder, the same command operates it:
|
|
16
18
|
|
|
17
19
|
```bash
|
|
18
|
-
unoverse
|
|
20
|
+
unoverse start # run it (--pull for the latest images)
|
|
21
|
+
unoverse check # is it healthy
|
|
22
|
+
unoverse logs # what is it doing
|
|
23
|
+
unoverse where # its addresses, local and deployed, probed live
|
|
24
|
+
unoverse deploy # ship it to your server
|
|
25
|
+
unoverse stop
|
|
19
26
|
```
|
|
27
|
+
|
|
28
|
+
## Build with Claude
|
|
29
|
+
|
|
30
|
+
Creating a universe also installs a Claude Code skill (`.claude/skills/unoverse-create`)
|
|
31
|
+
and registers the `canvas` MCP (`.mcp.json`). Open the folder in Claude Code and ask for
|
|
32
|
+
what you want: components, templates, custom nodes, agent skills, or whole workflows
|
|
33
|
+
built live on your Canvas. `unoverse update` keeps the CLI and the skill current.
|
|
34
|
+
|
|
35
|
+
Documentation: https://github.com/unoverse-platform/docs
|
|
@@ -67,21 +67,21 @@ material.
|
|
|
67
67
|
|
|
68
68
|
## Step 3 — Deploy loop (after the artifact is written)
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
70
|
+
Components and templates have NO scaffold command — author them from the references
|
|
71
|
+
(mirror the closest existing artifact). Validation lives in Studio: its publish step
|
|
72
|
+
lints every definition before anything leaves the machine (0 errors required, doc-cited
|
|
73
|
+
messages; justify any warning), and the conformance checklist is
|
|
74
|
+
[UNOVERSE_CONFORMANCE](https://github.com/unoverse-platform/docs/blob/main/unoverse/UNOVERSE_CONFORMANCE.md).
|
|
75
75
|
|
|
76
76
|
| Artifact | To see it live |
|
|
77
77
|
|---|---|
|
|
78
|
-
| Component / atom / template / style |
|
|
79
|
-
| Existing component restyle/edit only | takes effect live (SDK reads `rx/` directly) |
|
|
80
|
-
| Agent skill / prompt block |
|
|
81
|
-
| Node |
|
|
78
|
+
| Component / atom / template / style | Preview in Studio (`unoverse studio`), then publish from Studio — the publish lint gates it |
|
|
79
|
+
| Existing component restyle/edit only | takes effect live (the SDK reads `rx/` directly) |
|
|
80
|
+
| Agent skill / prompt block | publish from Studio, same gate |
|
|
81
|
+
| Node | Studio's Nodes screen: Load sample → Run. A node is YAML; running it is the only proof (no build) |
|
|
82
82
|
|
|
83
|
-
Verify with
|
|
84
|
-
|
|
83
|
+
Verify the platform with `unoverse check` (services, schema, environment). Studio opens
|
|
84
|
+
on :4108 (`unoverse studio` from the project folder).
|
|
85
85
|
|
|
86
86
|
> In the platform monorepo (not the starter), the node docs live at
|
|
87
87
|
> `packages/docs/nodes/`, the design journey at `packages/docs/design/`, and the dev loop
|
|
@@ -62,4 +62,4 @@ is invalid.
|
|
|
62
62
|
## Ship
|
|
63
63
|
|
|
64
64
|
`docker compose restart unoverse` — the runtime rescans skills at boot. Verify the
|
|
65
|
-
skill appears via the platform's skill listing (
|
|
65
|
+
skill appears via the platform's skill listing (`unoverse check` for overall health).
|
|
@@ -22,7 +22,7 @@ apps/unoverse/rx/orgs/<org>/components/<name>/ # ORG tier (the client's own micr
|
|
|
22
22
|
A **flat component** (simple card/chart) is just `<name>.json` + `root` — one face, no manifest,
|
|
23
23
|
no folders. Structure is EARNED; start flat.
|
|
24
24
|
|
|
25
|
-
## The rules (lint enforces all of these — 0 errors required)
|
|
25
|
+
## The rules (Studio's publish lint enforces all of these — 0 errors required)
|
|
26
26
|
|
|
27
27
|
1. **Three homes for everything it shows** (AUTHORING §3):
|
|
28
28
|
- static content → **hardcoded literals** in the layout (`value`, literal `items: []` on
|
|
@@ -147,6 +147,6 @@ component — its key nouns/verbs must appear in `whenToUse`'s first sentence.
|
|
|
147
147
|
|
|
148
148
|
1. Study the closest exemplar; copy its folder shape.
|
|
149
149
|
2. Write the envelope + manifest + layouts; put every shown thing in its ONE home.
|
|
150
|
-
3.
|
|
150
|
+
3. Publish from Studio — its lint must report 0 errors (it cites the doc for every rule).
|
|
151
151
|
4. Restart unoverse → Studio: mock (prop defaults + state picker + Inline/Focused
|
|
152
152
|
toggle), then live. Debug: stream log → state inspector → definition; never guess.
|
|
@@ -119,14 +119,14 @@ package only for a new integration.
|
|
|
119
119
|
## Verify
|
|
120
120
|
|
|
121
121
|
```bash
|
|
122
|
-
|
|
123
|
-
|
|
122
|
+
Studio → Nodes → your node (the catalog load reports schema errors)
|
|
123
|
+
Studio's Nodes screen (Load sample → Run)
|
|
124
124
|
```
|
|
125
125
|
|
|
126
126
|
Both must pass before the node is done. Lint names the rule and the page behind it, so read
|
|
127
127
|
the message rather than guessing.
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
The Studio node runner calls the real service and needs no platform running. It reads keys from `.env`
|
|
130
130
|
as `<CREDENTIAL>_<FIELD>` in upper snake case, so `openAICredential.apiKey` is
|
|
131
131
|
`OPENAI_API_KEY`.
|
|
132
132
|
|
|
@@ -107,7 +107,7 @@ themes `unoverse://theme/<org>/<theme>`.
|
|
|
107
107
|
|
|
108
108
|
## Validate & ship
|
|
109
109
|
|
|
110
|
-
1.
|
|
110
|
+
1. Publish from Studio — its lint must report 0 errors (layout/name-sync rules, widths, reaction rules, tokens).
|
|
111
111
|
2. Restart unoverse — the node re-synthesizes.
|
|
112
112
|
3. **See it**: Studio — layout pills on top (default first, stateOrder order), local
|
|
113
113
|
states down the left, freely combinable; acting inside the preview transitions like
|
|
@@ -7,7 +7,7 @@ in the developer's browser as you build.
|
|
|
7
7
|
|
|
8
8
|
## Prerequisites (check before starting)
|
|
9
9
|
|
|
10
|
-
1. **The platform is running** (
|
|
10
|
+
1. **The platform is running** (`unoverse start`, or `npm run dev` in the platform
|
|
11
11
|
repo). The builder listens on `localhost:4106` — local machine only, by design.
|
|
12
12
|
2. **The MCP is connected**: `canvas` should show connected with 14 tools.
|
|
13
13
|
If it shows failed, the platform wasn't up when the session started — reconnect
|
package/package.json
CHANGED