@zoahhq/cli 0.1.0 → 0.1.3
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 +28 -17
- package/dist/cli.mjs +5960 -5564
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -67,9 +67,9 @@ zoah whoami
|
|
|
67
67
|
|
|
68
68
|
### `zoah mcp`
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
70
|
+
Runs the Zoah MCP server over stdio so a coding agent (Claude Code, Codex,
|
|
71
|
+
Cursor, or any MCP-capable harness) can read and edit a Zoah project from your
|
|
72
|
+
terminal session. The agent gets the same verbs the designer uses:
|
|
73
73
|
nodes, pages, components, slots, variants, variables, themes, breakpoints and
|
|
74
74
|
events, plus branch and pull-request tools.
|
|
75
75
|
|
|
@@ -96,11 +96,22 @@ It asks four things:
|
|
|
96
96
|
| Which harness | Claude Code, Cursor, VS Code, Codex, or print the snippet | Pick the harness that will use Zoah |
|
|
97
97
|
| How to launch | `npx -y @zoahhq/cli@latest`, or the global `zoah` binary | `npx` for a config you check in, so teammates need no install |
|
|
98
98
|
| What agents may do | full access, or `--read-only` | read-only serves the query verbs alone |
|
|
99
|
-
| Default project | the repo's linked project from `.zoah/config.json`, or none | baking it in means `connect` needs no
|
|
99
|
+
| Default project | the repo's linked project from `.zoah/config.json`, or none | baking it in means `connect` needs no IDs |
|
|
100
100
|
|
|
101
|
-
It merges into an existing config without disturbing other servers.
|
|
102
|
-
is also a flag (`--harness`, `--global-command`, `--read-only`,
|
|
103
|
-
`--print`) for scripted setup.
|
|
101
|
+
It merges into an existing project config without disturbing other servers.
|
|
102
|
+
Every answer is also a flag (`--harness`, `--global-command`, `--read-only`,
|
|
103
|
+
`--project`, `--print`) for scripted setup.
|
|
104
|
+
|
|
105
|
+
For Codex, the installer runs `codex mcp add`. Codex writes the global server
|
|
106
|
+
entry that its CLI and IDE extension share. The installer checks for an
|
|
107
|
+
existing `zoah` server first. Interactive setup asks before replacement.
|
|
108
|
+
Scripted setup leaves an existing entry unchanged. If Codex is unavailable or
|
|
109
|
+
its server list is unsafe to read, the installer prints a complete global TOML
|
|
110
|
+
entry instead. Zoah never edits Codex TOML directly. See the
|
|
111
|
+
[Codex MCP documentation](https://developers.openai.com/codex/mcp).
|
|
112
|
+
|
|
113
|
+
The confirmation shows the resolved instance as one URL. The standard
|
|
114
|
+
production instance is `https://zoah.com`.
|
|
104
115
|
|
|
105
116
|
To write the entry by hand instead:
|
|
106
117
|
|
|
@@ -128,7 +139,7 @@ fresh `agent/<timestamp>` branch off main, so an agent's edits stay reviewable
|
|
|
128
139
|
rather than landing on main.
|
|
129
140
|
|
|
130
141
|
**4. Check it worked.** `status` reports the connected project, the branch, and
|
|
131
|
-
|
|
142
|
+
organization role. It also reports credential health. `whoami` reports the
|
|
132
143
|
identity, role, and instance.
|
|
133
144
|
|
|
134
145
|
#### What the agent gets
|
|
@@ -138,17 +149,17 @@ session without direct human confirmation. Confirmation actions stay in the
|
|
|
138
149
|
Zoah app. The server replaces renderer-only and workspace-agent verbs with
|
|
139
150
|
the session tools below.
|
|
140
151
|
|
|
141
|
-
| Group
|
|
142
|
-
|
|
|
143
|
-
| Session
|
|
144
|
-
|
|
|
145
|
-
| Branches
|
|
146
|
-
| Pull requests
|
|
147
|
-
| Canvas
|
|
152
|
+
| Group | Tools |
|
|
153
|
+
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
154
|
+
| Session | `connect`, `status`, `pullEvents`, `disconnect`, `whoami`, `logout`, `describeProperties` |
|
|
155
|
+
| Organizations and projects | `listOrganizations`, `createOrganization`, `listProjects`, `createProject`, `updateProject` |
|
|
156
|
+
| Branches | `listBranches`, `createBranch` |
|
|
157
|
+
| Pull requests | `createPullRequest`, `getPullRequest`, `updatePullRequest`, `commentOnPullRequest` |
|
|
158
|
+
| Canvas | one per applicable Action API verb for nodes, pages, components, slots, variants, variables, themes, breakpoints, events, and queries |
|
|
148
159
|
|
|
149
160
|
Two properties are worth knowing. Mutation tools return only after the sync
|
|
150
161
|
gateway acks the write, so a returned success means persisted, not queued. And
|
|
151
|
-
the server does not provide branch, project, or
|
|
162
|
+
the server does not provide branch, project, or organization deletion.
|
|
152
163
|
`pullEvents` returns structured rejection and collaborator action details. It
|
|
153
164
|
also returns merge summaries. Sync and cache signals mean the agent should
|
|
154
165
|
re-query after reconnect catch-up.
|
|
@@ -328,7 +339,7 @@ When the import fails (e.g. the server returns 400 because no components were ex
|
|
|
328
339
|
|
|
329
340
|
Commit these files. They bind the checkout to the Zoah project:
|
|
330
341
|
|
|
331
|
-
- `.zoah/config.json`:
|
|
342
|
+
- `.zoah/config.json`: organization and project binding, written on the first import.
|
|
332
343
|
- `.zoah/components.json`: component IDs, package exports, and slot anchors.
|
|
333
344
|
- `.zoah/manifest.json`: published package name, version, and registry URL.
|
|
334
345
|
|