@animaapp/cli 0.5.1 → 0.6.0
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 +101 -41
- package/dist/index.js +408 -269
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ build, host, publish, and share apps. This CLI is how an agent *uses* AgentGrid
|
|
|
5
5
|
from a shell.
|
|
6
6
|
|
|
7
7
|
**What it does.** Connect as a scoped agent identity, then work with **artifacts**
|
|
8
|
-
(
|
|
8
|
+
(each one a real git repo): create them from your own code or from a
|
|
9
9
|
prompt/URL/Figma design, edit them over git, publish them to a live URL, and list
|
|
10
10
|
your team's artifacts to resume recent work. Every command runs an AgentGrid MCP
|
|
11
11
|
tool for you.
|
|
@@ -13,7 +13,8 @@ tool for you.
|
|
|
13
13
|
**How it works.** Built for **agents**: any AI tool that can run a shell command
|
|
14
14
|
can use it — no MCP server to configure, no plugins, just `npx`. Under the hood
|
|
15
15
|
each command talks to AgentGrid over MCP (`api.agentgrid.io`), and your access is a
|
|
16
|
-
**scoped, revocable
|
|
16
|
+
**scoped, revocable identity** your human approved, renewed for you as it
|
|
17
|
+
expires. If your runtime speaks
|
|
17
18
|
MCP natively, `login` once then `mcp-config` to skip the CLI and call the tools
|
|
18
19
|
directly.
|
|
19
20
|
|
|
@@ -34,8 +35,10 @@ npx @animaapp/cli@latest create -t p2c -p "SaaS dashboard with sidebar and analy
|
|
|
34
35
|
## Connecting an agent
|
|
35
36
|
|
|
36
37
|
Every command runs as a **scoped agent identity**: it acts only within the
|
|
37
|
-
workspaces and capabilities a human approved, your team can see and
|
|
38
|
-
at any time
|
|
38
|
+
workspaces and capabilities a human approved, and your team can see and
|
|
39
|
+
**revoke** it at any time. The CLI renews it in the background; after a few
|
|
40
|
+
months the consent reaches its renewal limit and a human approves again. You get
|
|
41
|
+
that identity one of three ways — the third also covers the case where you have no human to ask yet.
|
|
39
42
|
|
|
40
43
|
### 1. Device login — `anima login`
|
|
41
44
|
|
|
@@ -86,6 +89,33 @@ export FIGMA_TOKEN=<token> # only for codegen / f2c
|
|
|
86
89
|
|
|
87
90
|
Resolution priority: `ANIMA_API_TOKEN` env var → stored credentials file → error.
|
|
88
91
|
|
|
92
|
+
### 3. Create first, hand off later — anonymous artifacts
|
|
93
|
+
|
|
94
|
+
When there is **no human available yet** and no token, you can still put work on
|
|
95
|
+
AgentGrid. Create an artifact anonymously over REST (the CLI needs an identity,
|
|
96
|
+
so this one call is plain `curl`), then hand it to a human when they appear:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
curl -s -X POST "https://public-api.animaapp.com/v1/generationSessions" \
|
|
100
|
+
-H 'Content-Type: application/json' \
|
|
101
|
+
-d '{"type":"import","name":"My project","clientName":"Claude Code",
|
|
102
|
+
"files":{"index.html":"<!doctype html><h1>hi</h1>"}}'
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
**Send `clientName` — say what product you are** (`"Claude Code"`, `"Cursor"`,
|
|
106
|
+
…), the same name you would pass to `login --client-name`. The human sees it on
|
|
107
|
+
the claim page and it becomes the agent name they approve; without it they are
|
|
108
|
+
asked to invent a name for an artifact they did not create. Display-only, never
|
|
109
|
+
verified, ≤120 characters.
|
|
110
|
+
|
|
111
|
+
The response returns a claim link for your human plus a `handoffToken` for you.
|
|
112
|
+
The token does **not** claim anything — it groups further anonymous creates into
|
|
113
|
+
the same handoff, and you poll `POST /oauth/token` with it
|
|
114
|
+
(`grant_type=urn:animaapp:params:oauth:grant-type:handoff_token`) until the
|
|
115
|
+
human claims, at which point the poll returns your agent token. Store it and use
|
|
116
|
+
it as `ANIMA_API_TOKEN` (door 2) for every command after that. Anonymous
|
|
117
|
+
artifacts are read-only and expire in 24h if nobody claims them.
|
|
118
|
+
|
|
89
119
|
### Which do I use?
|
|
90
120
|
|
|
91
121
|
| Situation | How to connect |
|
|
@@ -94,6 +124,7 @@ Resolution priority: `ANIMA_API_TOKEN` env var → stored credentials file → e
|
|
|
94
124
|
| Interactive agent, human nearby | `anima login` — show the URL + code, human approves on any device |
|
|
95
125
|
| Headless agent, human reachable | `anima login --json` — relay the `verification_required` event, polling finishes automatically |
|
|
96
126
|
| Fully headless / CI, no human | set `ANIMA_API_TOKEN` — no login step |
|
|
127
|
+
| No human *yet*, nothing to authenticate with | create anonymously with `clientName`, send the claim link, poll for the token |
|
|
97
128
|
|
|
98
129
|
---
|
|
99
130
|
|
|
@@ -115,6 +146,9 @@ npx @animaapp/cli@latest publish <sessionId>
|
|
|
115
146
|
# ...or start empty and push over git
|
|
116
147
|
npx @animaapp/cli@latest create -t empty --framework react --name "My project"
|
|
117
148
|
npx @animaapp/cli@latest get-git-token <sessionId> # then: git clone <url>, add code, git push
|
|
149
|
+
|
|
150
|
+
# ...or create an independent copy of an existing artifact
|
|
151
|
+
npx @animaapp/cli@latest duplicate <artifactUrl-or-sessionId> --name "My copy"
|
|
118
152
|
```
|
|
119
153
|
|
|
120
154
|
---
|
|
@@ -138,27 +172,27 @@ npx @animaapp/cli@latest login --invite <url-or-code> # redeem a pre-app
|
|
|
138
172
|
| `--no-open` | Don't try to open the verification page in a browser | — |
|
|
139
173
|
| `--print-mcp-config` | One-shot: after this fresh login, also print the MCP server config. If you are already logged in, use `mcp-config` instead — this flag always starts a new login | off |
|
|
140
174
|
|
|
141
|
-
### `mcp-config` — print your MCP server config
|
|
175
|
+
### `mcp-config` — print your MCP server config
|
|
142
176
|
|
|
143
177
|
```bash
|
|
144
178
|
npx @animaapp/cli@latest mcp-config
|
|
145
179
|
```
|
|
146
180
|
|
|
147
|
-
Prints a ready-to-paste remote MCP server entry
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
181
|
+
Prints a ready-to-paste remote MCP server entry pointing at `/v1/mcp`. It
|
|
182
|
+
contains **no credential** and needs none: your MCP client authorizes itself
|
|
183
|
+
against the server and holds a credential it can renew on its own. No network
|
|
184
|
+
call, no device flow. `--json` wraps it as `{ success, mcpConfig }`.
|
|
151
185
|
|
|
152
|
-
**MCP-capable agents:**
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
by `mcp-config` and `--print-mcp-config`.
|
|
186
|
+
**MCP-capable agents:** run `mcp-config`, add the entry to your client, and
|
|
187
|
+
authorize when it prompts. No CLI in the loop after that. Your client needs to
|
|
188
|
+
support OAuth for remote MCP servers (`.well-known` discovery); if it cannot,
|
|
189
|
+
use the CLI commands instead.
|
|
157
190
|
|
|
158
|
-
### `create` —
|
|
191
|
+
### `create` — an artifact for your code, or AI-generated
|
|
159
192
|
|
|
160
193
|
```bash
|
|
161
194
|
npx @animaapp/cli@latest create -t import --from ./my-project # import YOUR code (instant)
|
|
195
|
+
npx @animaapp/cli@latest create -t import --from ./notes --artifact-type markdown # a readable document
|
|
162
196
|
npx @animaapp/cli@latest create -t empty --framework react --name "My project" # empty repo you push to (instant)
|
|
163
197
|
npx @animaapp/cli@latest create -t p2c -p "Analytics dashboard with a sidebar"
|
|
164
198
|
npx @animaapp/cli@latest create -t l2c -u https://stripe.com
|
|
@@ -166,12 +200,19 @@ npx @animaapp/cli@latest create -t f2c --file-key <key> --nodes 42:15
|
|
|
166
200
|
```
|
|
167
201
|
|
|
168
202
|
`-t import` is the one-step upload path: your folder (or .zip) becomes the
|
|
169
|
-
|
|
203
|
+
artifact's first commit — small text-only projects are sent inline, larger
|
|
170
204
|
or binary ones are zipped and uploaded via a presigned URL automatically.
|
|
171
205
|
`-t empty` creates an empty repository instead: follow with `git clone` of the
|
|
172
206
|
returned URL, add your code, and `git push`. Then `publish <sessionId>` for a
|
|
173
207
|
live URL. The other types are AI generation (3–7 min).
|
|
174
208
|
|
|
209
|
+
`--artifact-type` is a separate question from `-t`: `-t` is how the repository
|
|
210
|
+
starts, `--artifact-type` is what the artifact IS, and it decides how a human
|
|
211
|
+
sees it. `app` is a running web page and needs an `index.html`; `markdown` is a
|
|
212
|
+
readable document and needs `.md` files. Omit it and the server infers one:
|
|
213
|
+
markdown when your files are `.md`/`.mdx` with no HTML, otherwise app. Getting it wrong is the common mistake — `.md` files
|
|
214
|
+
uploaded as an app produce an artifact with nothing to render.
|
|
215
|
+
|
|
175
216
|
| Option | Values | Default |
|
|
176
217
|
|--------|--------|---------|
|
|
177
218
|
| `-t, --type` | `import` (your code, with `--from`), `empty` (repo to push to), `p2c` (prompt), `l2c` (URL), `f2c` (Figma) | _required_ |
|
|
@@ -182,7 +223,8 @@ live URL. The other types are AI generation (3–7 min).
|
|
|
182
223
|
| `--file-key` | Figma file key or URL | _(f2c)_ |
|
|
183
224
|
| `--nodes` | Figma node IDs, comma-separated | _(f2c)_ |
|
|
184
225
|
| `--figma-token` | Figma PAT (or `FIGMA_TOKEN` env) | _(f2c)_ |
|
|
185
|
-
| `--
|
|
226
|
+
| `--artifact-type` | `app` (web page, needs an `index.html`), `markdown` (document, needs `.md` files), `asset` (images/video, with a zip) | _inferred from your files_ |
|
|
227
|
+
| `--framework` | `react`, `html` — apps only | `react` |
|
|
186
228
|
| `--styling` | `tailwind`, `css`, `plain_css`, `css_modules`, `inline_styles`¹ | `tailwind` |
|
|
187
229
|
| `--language` | `typescript`, `javascript` | `typescript` (react) |
|
|
188
230
|
| `--ui-library` | `shadcn`, `mui`, `antd`, `clean_react` | _(none)_ |
|
|
@@ -191,7 +233,25 @@ live URL. The other types are AI generation (3–7 min).
|
|
|
191
233
|
¹ The valid styling / UI-library set depends on `--type`; the server validates and
|
|
192
234
|
returns a clear error for unsupported combinations.
|
|
193
235
|
|
|
194
|
-
### `
|
|
236
|
+
### `duplicate` — copy an existing artifact
|
|
237
|
+
|
|
238
|
+
```bash
|
|
239
|
+
npx @animaapp/cli@latest duplicate <artifactUrl-or-sessionId>
|
|
240
|
+
npx @animaapp/cli@latest duplicate <artifactUrl-or-sessionId> --name "My copy"
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
Creates a new, independent artifact in the current team's Default workspace.
|
|
244
|
+
It copies code, assets, and supported database content, but does **not** copy
|
|
245
|
+
chat or custom domains. The source must be readable and the destination
|
|
246
|
+
workspace must be writable. Without `--name`, the API names it
|
|
247
|
+
`<source name> (Copy)`.
|
|
248
|
+
|
|
249
|
+
The result includes the new and source session IDs, duplicate name,
|
|
250
|
+
`playgroundUrl`, `previewUrl`, and API-provided next steps. Duplication is not
|
|
251
|
+
idempotent: if a request times out or its response is lost, run `list` and check
|
|
252
|
+
recent artifacts before retrying.
|
|
253
|
+
|
|
254
|
+
### `codegen` — Figma to local files (no artifact)
|
|
195
255
|
|
|
196
256
|
```bash
|
|
197
257
|
npx @animaapp/cli@latest codegen --file-key <key-or-url> --nodes 42:15 -o ./components
|
|
@@ -210,30 +270,27 @@ npx @animaapp/cli@latest codegen --file-key <key-or-url> --nodes 42:15 -o ./comp
|
|
|
210
270
|
|
|
211
271
|
### `publish` — deploy a session to a public URL (1–3 min)
|
|
212
272
|
|
|
213
|
-
Publishing makes the
|
|
214
|
-
doesn't need it — the
|
|
273
|
+
Publishing makes the app **public to the world**. Sharing usually
|
|
274
|
+
doesn't need it — the artifact is already visible at its `playgroundUrl`.
|
|
215
275
|
**Agents:** only publish when the human explicitly asked for a public site;
|
|
216
|
-
otherwise share
|
|
276
|
+
otherwise share that URL and offer publishing as a follow-up.
|
|
217
277
|
|
|
218
278
|
```bash
|
|
219
279
|
npx @animaapp/cli@latest publish <sessionId>
|
|
220
|
-
npx @animaapp/cli@latest publish <sessionId> --mode designSystem --package-name my-ds
|
|
221
280
|
```
|
|
222
281
|
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
| `--package-name` | npm package name | _(designSystem)_ |
|
|
227
|
-
| `--package-version` | npm package version | _(designSystem)_ |
|
|
282
|
+
Deploys the artifact's app to a live URL. Publishing as a design-system npm
|
|
283
|
+
package is an enterprise feature and is not reachable over MCP, so this CLI
|
|
284
|
+
does not offer it.
|
|
228
285
|
|
|
229
|
-
### `unpublish` — take a published
|
|
286
|
+
### `unpublish` — take a published artifact offline
|
|
230
287
|
|
|
231
288
|
```bash
|
|
232
289
|
npx @animaapp/cli@latest unpublish <sessionId>
|
|
233
290
|
```
|
|
234
291
|
|
|
235
292
|
The inverse of `publish`: clears the live URL so the deployed site stops being
|
|
236
|
-
reachable. The
|
|
293
|
+
reachable. The artifact, its code, and its content are untouched; publishing
|
|
237
294
|
again reuses the same subdomain.
|
|
238
295
|
|
|
239
296
|
### `update` — rename or change visibility (metadata only)
|
|
@@ -246,19 +303,19 @@ npx @animaapp/cli@latest update <sessionId> --privacy private # team only
|
|
|
246
303
|
|
|
247
304
|
Never touches code or content — that's the git flow (`get-git-token`).
|
|
248
305
|
|
|
249
|
-
### `get-git-token` — read/edit
|
|
306
|
+
### `get-git-token` — read/edit an artifact's code over git
|
|
250
307
|
|
|
251
308
|
```bash
|
|
252
309
|
npx @animaapp/cli@latest get-git-token https://dev.animaapp.com/chat/<sessionId>
|
|
253
310
|
```
|
|
254
311
|
|
|
255
|
-
|
|
312
|
+
An artifact **is** a git repository, and git is the only way to read or edit
|
|
256
313
|
its code. This command mints a short-lived access token scoped to that one
|
|
257
|
-
|
|
314
|
+
artifact and prints a ready-to-use remote URL — you run git yourself:
|
|
258
315
|
|
|
259
316
|
```bash
|
|
260
317
|
git clone <gitRemoteUrl> # read (and edit locally)
|
|
261
|
-
git push # read-write access: updates the live
|
|
318
|
+
git push # read-write access: updates the live artifact
|
|
262
319
|
git remote set-url origin <new url> # after expiry: re-run get-git-token, re-point the clone
|
|
263
320
|
```
|
|
264
321
|
|
|
@@ -272,11 +329,13 @@ secret, and re-mint rather than store it.
|
|
|
272
329
|
npx @animaapp/cli@latest logout
|
|
273
330
|
```
|
|
274
331
|
|
|
275
|
-
A full
|
|
276
|
-
token, agent metadata) **and the CLI
|
|
277
|
-
by `login --invite`) — the machine
|
|
278
|
-
|
|
279
|
-
|
|
332
|
+
A full reset: revokes the agent credentials server-side, then clears **all**
|
|
333
|
+
stored credentials (AgentGrid token, Figma token, agent metadata) **and the CLI
|
|
334
|
+
config** (including an `api-url` persisted by `login --invite`) — the machine
|
|
335
|
+
ends up pristine, as if the CLI was never used. Because the revocation is
|
|
336
|
+
server-side, a copy of the token taken from this machine stops working too.
|
|
337
|
+
The agent identity itself remains on your team roster; revoke it there to retire
|
|
338
|
+
it for good.
|
|
280
339
|
|
|
281
340
|
### `config` — store CLI preferences
|
|
282
341
|
|
|
@@ -307,8 +366,8 @@ npx @animaapp/cli@latest auth --logout # alias for `anima logout`
|
|
|
307
366
|
|
|
308
367
|
## Global flags
|
|
309
368
|
|
|
310
|
-
Available on the network commands (`login`, `create`, `
|
|
311
|
-
`get-git-token`):
|
|
369
|
+
Available on the network commands (`login`, `create`, `duplicate`, `codegen`,
|
|
370
|
+
`publish`, `get-git-token`):
|
|
312
371
|
|
|
313
372
|
| Flag | Description | Default |
|
|
314
373
|
|------|-------------|---------|
|
|
@@ -318,7 +377,8 @@ Available on the network commands (`login`, `create`, `codegen`, `publish`,
|
|
|
318
377
|
| `--log-file <path>` | Append a JSON debug log of each step to a file | off |
|
|
319
378
|
| `--timeout <ms>` | Request timeout² | `600000` (10 min) |
|
|
320
379
|
|
|
321
|
-
¹ `--verbose` applies to `create` / `codegen` / `publish` /
|
|
380
|
+
¹ `--verbose` applies to `create` / `duplicate` / `codegen` / `publish` /
|
|
381
|
+
`get-git-token`.
|
|
322
382
|
² `--timeout` applies to `create` / `codegen`. Don't lower it — generation takes
|
|
323
383
|
minutes.
|
|
324
384
|
³ Falls back to `ANIMA_API_URL`, then `anima config set api-url`, then the
|