@zibby/skills 0.2.23 → 0.2.24
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/dist/browser.d.ts +0 -17
- package/dist/browser.js +3 -3
- package/dist/code-scan.d.ts +1 -1
- package/dist/index.d.ts +0 -1
- package/dist/index.js +97 -97
- package/dist/jira.d.ts +75 -9
- package/dist/jira.js +4 -4
- package/dist/package.json +1 -1
- package/dist/report.d.ts +51 -276
- package/dist/trackers/index.js +12 -12
- package/dist/trackers/jira-adapter.js +11 -11
- package/package.json +1 -1
- package/docs/analysis.md +0 -109
- package/docs/apps/agent-ops.md +0 -130
- package/docs/apps/auth.md +0 -158
- package/docs/apps/deploy.md +0 -207
- package/docs/apps/goal-mode.md +0 -175
- package/docs/apps/index.md +0 -149
- package/docs/apps/managing.md +0 -121
- package/docs/cli-reference.md +0 -494
- package/docs/cloning-repositories.md +0 -285
- package/docs/cloud/bundles.md +0 -92
- package/docs/cloud/dedicated-egress.md +0 -140
- package/docs/cloud/editing-prompts.md +0 -79
- package/docs/cloud/env-vars.md +0 -144
- package/docs/cloud/limits.md +0 -81
- package/docs/cloud/logs.md +0 -104
- package/docs/cloud/triggering.md +0 -128
- package/docs/concepts/agents.md +0 -112
- package/docs/concepts/designing-agents.md +0 -247
- package/docs/concepts/graph.md +0 -83
- package/docs/concepts/sessions.md +0 -70
- package/docs/concepts/skills.md +0 -86
- package/docs/concepts/state.md +0 -106
- package/docs/concepts/sub-graphs.md +0 -227
- package/docs/custom-workflows.md +0 -358
- package/docs/get-started/deploy.md +0 -75
- package/docs/get-started/install.md +0 -60
- package/docs/get-started/run-locally.md +0 -94
- package/docs/get-started/trigger-and-logs.md +0 -90
- package/docs/get-started/use-from-agents.md +0 -153
- package/docs/get-started/your-first-workflow.md +0 -69
- package/docs/getting-started.md +0 -108
- package/docs/installation.md +0 -127
- package/docs/integrations/github.md +0 -73
- package/docs/integrations/gitlab.md +0 -43
- package/docs/integrations/jira.md +0 -71
- package/docs/integrations/lark.md +0 -41
- package/docs/integrations/linear.md +0 -43
- package/docs/integrations/notion.md +0 -33
- package/docs/integrations/plane.md +0 -46
- package/docs/integrations/sentry.md +0 -42
- package/docs/integrations/slack.md +0 -33
- package/docs/intro.md +0 -86
- package/docs/legacy/test-automation.md +0 -111
- package/docs/packages/agent-workflow.md +0 -88
- package/docs/packages/cli.md +0 -73
- package/docs/packages/core.md +0 -72
- package/docs/packages/mcp-browser.md +0 -110
- package/docs/packages/mcp-cli.md +0 -176
- package/docs/packages/memory.md +0 -223
- package/docs/packages/skills.md +0 -218
- package/docs/packages/ui-memory.md +0 -245
- package/docs/recipes/bug-autofix.md +0 -85
- package/docs/recipes/github-ai-scout.md +0 -61
- package/docs/recipes/index.md +0 -68
- package/docs/recipes/pipeline-supervisor.md +0 -57
- package/docs/recipes/sentry-triage.md +0 -93
- package/docs/recipes/test.md +0 -190
- package/docs/reviewing-results.md +0 -114
- package/docs/running-tests.md +0 -134
- package/docs/self-host/backup-restore.md +0 -53
- package/docs/self-host/custom-sidecars.md +0 -136
- package/docs/self-host/index.md +0 -75
- package/docs/self-host/storage.md +0 -50
- package/docs/self-host/troubleshooting.md +0 -48
- package/docs/self-host/upgrade.md +0 -81
- package/docs/skills/browser.md +0 -97
- package/docs/skills/chat-memory.md +0 -122
- package/docs/skills/core-tools.md +0 -80
- package/docs/skills/function-skill.md +0 -93
- package/docs/skills/github.md +0 -91
- package/docs/skills/index.md +0 -46
- package/docs/skills/jira.md +0 -99
- package/docs/skills/lark.md +0 -85
- package/docs/skills/memory.md +0 -92
- package/docs/skills/sentry.md +0 -80
- package/docs/skills/slack.md +0 -89
- package/docs/tests/memory.md +0 -131
- package/docs/triggering-workflows.md +0 -552
- package/docs/workflow-artifact-layout-evaluation.md +0 -119
- package/docs/workflow.md +0 -558
package/docs/cli-reference.md
DELETED
|
@@ -1,494 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
sidebar_position: 4
|
|
3
|
-
title: CLI Reference
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# CLI Reference
|
|
7
|
-
|
|
8
|
-
Every command lives under `zibby agent <verb>` for consistency. The bare top-level forms (`zibby start`, `zibby deploy`, `zibby trigger`, `zibby logs`) are kept as backward-compat aliases — they call the same handlers — but new code should use the namespaced forms.
|
|
9
|
-
|
|
10
|
-
## Agent commands
|
|
11
|
-
|
|
12
|
-
| Command | What it does |
|
|
13
|
-
|---|---|
|
|
14
|
-
| [`zibby agent new <name>`](#agent-new) | Scaffold a new custom agent under `.zibby/workflows/<name>/`. |
|
|
15
|
-
| [`zibby agent run <name>`](#agent-run) | One-shot local execution. Same input flags as `trigger`. |
|
|
16
|
-
| [`zibby agent list`](#agent-list) | List local + deployed agents. |
|
|
17
|
-
| [`zibby agent deploy [name]`](#agent-deploy) | Deploy to Zibby Cloud. Interactive picker if name omitted. |
|
|
18
|
-
| [`zibby agent trigger [uuid]`](#agent-trigger) | Run a deployed agent remotely. UUID is canonical. |
|
|
19
|
-
| [`zibby agent logs [uuid] -t`](#agent-logs) | Tail logs from a run, Heroku-style. |
|
|
20
|
-
| [`zibby agent download <uuid>`](#agent-download) | Pull a deployed agent back to local. Edit + redeploy. |
|
|
21
|
-
| [`zibby agent delete <uuid>`](#agent-delete) | Delete a deployed agent. |
|
|
22
|
-
| [`zibby agent start <name>`](#agent-start) | Long-lived dev server (Studio integration). Most users want `run`. |
|
|
23
|
-
| [`zibby agent update <uuid>`](#agent-update) | One-shot edit of a deployed agent: model, review @mention, trigger events, name, max runtime. |
|
|
24
|
-
| [`zibby agent env <verb>`](#agent-env) | Manage per-agent encrypted env vars: `list`, `set`, `unset`, `push`. |
|
|
25
|
-
|
|
26
|
-
Plus the test recipe + memory + project setup:
|
|
27
|
-
|
|
28
|
-
| Command | What it does |
|
|
29
|
-
|---|---|
|
|
30
|
-
| [`zibby test [spec]`](#test) | Run a test spec (or inline string). Drives the browser via Cursor / Claude / Codex / Gemini. |
|
|
31
|
-
| [`zibby memory <verb>`](#memory) | Local + remote test-memory DB: `init`, `stats`, `cost`, `compact`, `reset`, `pull`, `push`, `remote …`. |
|
|
32
|
-
| [`zibby init [project]`](#init) | Bootstrap a Zibby project (config + creds). `-t <template>` to also scaffold an agent. |
|
|
33
|
-
| [`zibby template <verb>`](#template) | List or add agent templates: `list`, `add <name>`. |
|
|
34
|
-
|
|
35
|
-
Auth + admin:
|
|
36
|
-
|
|
37
|
-
| Command | What it does |
|
|
38
|
-
|---|---|
|
|
39
|
-
| `zibby login` | OAuth in browser. Writes session to `~/.zibby/config.json`. |
|
|
40
|
-
| `zibby logout` | Clear session. |
|
|
41
|
-
| `zibby status` | Show current auth state. |
|
|
42
|
-
| `zibby list` | List projects + API tokens you have access to. |
|
|
43
|
-
|
|
44
|
-
## agent new {#agent-new}
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
zibby agent new [name]
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
Scaffolds `.zibby/workflows/<name>/` with a starter `graph.mjs`, `nodes/example.mjs`, `package.json`, and `workflow.json` manifest. Auto-runs `npm install` in the new folder unless `--skip-install`.
|
|
51
|
-
|
|
52
|
-
Options:
|
|
53
|
-
- `--skip-install` — skip `npm install`
|
|
54
|
-
- If `name` is omitted, the CLI generates one (`zealous-otter`, etc.)
|
|
55
|
-
|
|
56
|
-
## agent run {#agent-run}
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
zibby agent run <agent-name>
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
Loads `graph.mjs`, instantiates the entry class, runs the graph **once** in-process, prints results, and exits. Output → `.zibby/output/sessions/<sessionId>/`.
|
|
63
|
-
|
|
64
|
-
Mirrors `zibby agent trigger` so the same input flags work locally and in the cloud — flip the verb and the project, and your local dev loop is exactly the same call shape your CI/CD uses.
|
|
65
|
-
|
|
66
|
-
Options:
|
|
67
|
-
- `-p, --param <key=value>` — input param (repeatable, highest precedence). Example: `-p ticket=BUG-123 -p priority=high`
|
|
68
|
-
- `--input <json>` — input as JSON string
|
|
69
|
-
- `--input-file <path>` — input as JSON file (lowest precedence)
|
|
70
|
-
|
|
71
|
-
Examples:
|
|
72
|
-
```bash
|
|
73
|
-
zibby agent run my-agent
|
|
74
|
-
zibby agent run my-agent -p ticket=BUG-123
|
|
75
|
-
zibby agent run my-agent --input '{"ticket":"BUG-123","priority":"high"}'
|
|
76
|
-
zibby agent run my-agent --input-file payload.json -p priority=urgent
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
## agent start {#agent-start}
|
|
80
|
-
|
|
81
|
-
```bash
|
|
82
|
-
zibby agent start <agent-name>
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
Long-lived local dev server (default port 3848). Listens on `POST /trigger` for input payloads and runs the agent in-process. Used today by the Studio desktop app — for plain CLI use, prefer `agent run`.
|
|
86
|
-
|
|
87
|
-
Options:
|
|
88
|
-
- `-p, --port <port>` — override the default port (3848)
|
|
89
|
-
|
|
90
|
-
## agent list {#agent-list}
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
zibby agent list
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
Shows both local agents (folders under `.zibby/workflows/`) and deployed ones (from cloud, scoped to projects you have access to). Output is a table with UUID, Name, Project, Version. `-` in any column means "not applicable" (e.g. local-only agents have no UUID yet).
|
|
97
|
-
|
|
98
|
-
Options:
|
|
99
|
-
- `--local-only` — skip the cloud query
|
|
100
|
-
- `--remote-only` — skip the local scan
|
|
101
|
-
- `--project <id>` — filter to one project
|
|
102
|
-
|
|
103
|
-
## agent deploy {#agent-deploy}
|
|
104
|
-
|
|
105
|
-
```bash
|
|
106
|
-
zibby agent deploy [agent-name]
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
Two phases:
|
|
110
|
-
1. Upload sources to S3 (presigned PUT). The CLI also resolves your `.zibby.config.mjs` (if present at project root) and includes it in the bundle as `zibby.config.json` — see [Bundle build](./cloud/bundles).
|
|
111
|
-
2. CodeBuild downloads, runs `npm install --omit=dev`, packages a tarball, uploads it. The tarball is what each cloud execution downloads at trigger time.
|
|
112
|
-
|
|
113
|
-
After success, the CLI writes `.zibby/workflows/<name>/.zibby-deploy.json` with the canonical UUID. Commit this file.
|
|
114
|
-
|
|
115
|
-
Options:
|
|
116
|
-
- `--project <id>` — skip the project picker
|
|
117
|
-
- `--api-key <key>` — auth via API key (or set `ZIBBY_API_KEY`)
|
|
118
|
-
- `--env <path>` — sync a `.env` file into per-agent env vars after deploy. Repeatable (later files override). See [Per-agent env vars](./cloud/env-vars).
|
|
119
|
-
- `--verbose` — show raw CodeBuild logs during the bundle build
|
|
120
|
-
|
|
121
|
-
## agent trigger {#agent-trigger}
|
|
122
|
-
|
|
123
|
-
```bash
|
|
124
|
-
zibby agent trigger <uuid>
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
UUID is required (or omit for interactive picker). Names aren't accepted — pass the UUID from `.zibby-deploy.json` or `agent list`.
|
|
128
|
-
|
|
129
|
-
Options:
|
|
130
|
-
- `-p, --param <key=value>` — input param (repeatable, highest precedence)
|
|
131
|
-
- `--input <json>` — input as JSON string
|
|
132
|
-
- `--input-file <path>` — input as JSON/YAML file (lowest precedence)
|
|
133
|
-
- `--idempotency-key <key>` — prevent duplicate executions
|
|
134
|
-
- `--api-key <key>` — auth via API key
|
|
135
|
-
|
|
136
|
-
## agent logs {#agent-logs}
|
|
137
|
-
|
|
138
|
-
```bash
|
|
139
|
-
zibby agent logs <uuid> # dump latest run
|
|
140
|
-
zibby agent logs <uuid> -t # tail live (Heroku-style)
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
When `-t` is set and the agent finishes, the stream waits for the next trigger of the same agent and auto-switches to streaming it. Ctrl+C to exit.
|
|
144
|
-
|
|
145
|
-
Options:
|
|
146
|
-
- `-t, --follow` — live tail
|
|
147
|
-
- `--lines <n>` — max log lines per fetch (default: 500)
|
|
148
|
-
- `--all --workflow <name>` — interleaved logs from all runs (requires `--workflow`)
|
|
149
|
-
- `--api-key <key>` — auth via API key
|
|
150
|
-
|
|
151
|
-
**Storage & retention.** Live logs are kept in CloudWatch for 30 days. Beyond that, the per-run session folder (uploaded to S3 at the end of every execution) is the long-term archive — pull it back with `zibby agent download <uuid>`.
|
|
152
|
-
|
|
153
|
-
## agent update {#agent-update}
|
|
154
|
-
|
|
155
|
-
```bash
|
|
156
|
-
zibby agent update <uuid> --model claude:sonnet-4.6 # switch vendor:model
|
|
157
|
-
zibby agent update <uuid> --mention @zibby # review @mention token
|
|
158
|
-
zibby agent update <uuid> --triggers mention,comment # WHICH events fire a review
|
|
159
|
-
zibby agent update <uuid> --name "FE Review Bot" --max-runtime 30
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
The ONE consolidated editor for per-agent settings that used to be
|
|
163
|
-
dashboard-only. Flags can be combined; the command echoes the updated
|
|
164
|
-
settings so you can confirm what changed.
|
|
165
|
-
|
|
166
|
-
`--triggers` takes friendly names and controls **when a review agent runs**:
|
|
167
|
-
|
|
168
|
-
| Name | Fires on |
|
|
169
|
-
|---|---|
|
|
170
|
-
| `opened` | a new PR/MR is opened |
|
|
171
|
-
| `commit` | new commits are pushed to an open PR/MR |
|
|
172
|
-
| `mention` | someone @-mentions the agent, or replies in one of its threads |
|
|
173
|
-
|
|
174
|
-
`--triggers mention` is the cost-saving mode — the agent reviews **only when
|
|
175
|
-
asked**. New review agents deploy mention-only by default; existing agents keep
|
|
176
|
-
their current behaviour until you change it.
|
|
177
|
-
|
|
178
|
-
Driving Zibby from an AI editor instead of a shell? The MCP twin is
|
|
179
|
-
**`zibby_update_agent`** with the same fields (`model`, `mentionToken`,
|
|
180
|
-
`triggerEvents`, `displayName`, `maxRuntimeMinutes`).
|
|
181
|
-
|
|
182
|
-
Env vars, custom MCP servers and stores are separate surfaces:
|
|
183
|
-
`zibby agent env …`, `zibby_add_mcp`, `zibby_set_node_stores`.
|
|
184
|
-
|
|
185
|
-
## agent env {#agent-env}
|
|
186
|
-
|
|
187
|
-
Per-agent encrypted env vars — KMS-stored on the agent record, injected into the Fargate task at trigger time. Agent env wins over project secrets on conflict.
|
|
188
|
-
|
|
189
|
-
```bash
|
|
190
|
-
zibby agent env list <uuid> # show key names (no values)
|
|
191
|
-
zibby agent env set <uuid> ANTHROPIC_API_KEY=sk-… # add or rotate one
|
|
192
|
-
zibby agent env unset <uuid> OLD_KEY # remove one
|
|
193
|
-
zibby agent env push <uuid> --file .env [--file .env.prod] # bulk replace from .env files
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
`push` accepts repeatable `--file` (later files override). `list` only ever returns key names — values never leave the encrypted blob.
|
|
197
|
-
|
|
198
|
-
The shortcut for first-time setup is `zibby agent deploy --env .env`, which runs `push` automatically against the new UUID. Full guide: [Per-agent env vars](./cloud/env-vars).
|
|
199
|
-
|
|
200
|
-
## agent download {#agent-download}
|
|
201
|
-
|
|
202
|
-
```bash
|
|
203
|
-
zibby agent download <uuid>
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
Pulls the deployed agent's sources back into `.zibby/workflows/<name>/`, including the `.zibby-deploy.json` manifest. Useful when collaborators need the source from cloud.
|
|
207
|
-
|
|
208
|
-
Options:
|
|
209
|
-
- `--type <type>` — for built-in agents (`analysis`, `implementation`, `run_test`)
|
|
210
|
-
- `--output <dir>` — alternate output base
|
|
211
|
-
- `--include-default` — pull the built-in default graph if no custom one exists
|
|
212
|
-
|
|
213
|
-
## agent delete {#agent-delete}
|
|
214
|
-
|
|
215
|
-
```bash
|
|
216
|
-
zibby agent delete <uuid>
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
Removes the agent from cloud (and its trigger URL). Local files are not touched.
|
|
220
|
-
|
|
221
|
-
## test {#test}
|
|
222
|
-
|
|
223
|
-
```bash
|
|
224
|
-
zibby test [spec-path]
|
|
225
|
-
zibby test "go to example.com and verify the title is 'Example Domain'" # inline
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
Built-in browser-test recipe. Reads a `.txt` spec (or inline string), drives a real browser via the configured agent, generates a Playwright script + verification video. See [Recipes → Test](./recipes/test) for the long form.
|
|
229
|
-
|
|
230
|
-
Common options:
|
|
231
|
-
- `--agent <claude|cursor|codex|gemini>` — override the configured agent for this run
|
|
232
|
-
- `--workflow <name>` — use a non-default workflow (e.g. `QuickSmokeWorkflow`)
|
|
233
|
-
- `--headless` — run headless (default is headed)
|
|
234
|
-
- `-m, --mem` — enable test memory (Dolt-backed knowledge from prior runs)
|
|
235
|
-
- `--sources <ids> --execution <id>` — run cloud-stored test cases (comma-separated IDs)
|
|
236
|
-
- `--node <name> --session <id|last>` — re-execute one phase from a prior session
|
|
237
|
-
- `--sync` / `--no-sync` — force / skip cloud upload
|
|
238
|
-
- `--collection <id|name>` and `--folder <path>` — categorize the run on the cloud dashboard
|
|
239
|
-
- `--verbose` / `--debug` — escalate log levels
|
|
240
|
-
- `-o, --open` — open results in browser after completion
|
|
241
|
-
- `--auto-approve` — auto-approve MCP tools (CI/CD)
|
|
242
|
-
|
|
243
|
-
## memory {#memory}
|
|
244
|
-
|
|
245
|
-
Test memory is a local-first Dolt SQL DB at `.zibby/memory/.dolt/` that learns selectors, page model, navigation, and run history from every `zibby test` run. See [Test memory](./tests/memory) for the deeper explainer.
|
|
246
|
-
|
|
247
|
-
```bash
|
|
248
|
-
zibby memory init # initialize the local DB (auto-runs on first `zibby test -m`)
|
|
249
|
-
zibby memory stats # row counts, last commit, per-spec breakdown
|
|
250
|
-
zibby memory cost # real LLM token spend per spec / per domain
|
|
251
|
-
zibby memory compact # prune old runs + Dolt GC (default: --max-runs 50, --max-age 90)
|
|
252
|
-
zibby memory reset -f # wipe the DB
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
Optional team sync:
|
|
256
|
-
|
|
257
|
-
```bash
|
|
258
|
-
zibby memory remote add <url> # BYO: aws://, gs://, https://, file:///
|
|
259
|
-
zibby memory remote use --hosted # Zibby-managed S3 (signed-in users only)
|
|
260
|
-
zibby memory remote info # show current remote
|
|
261
|
-
zibby memory remote remove [name] # drop the remote (default: origin)
|
|
262
|
-
|
|
263
|
-
zibby memory pull # pull from remote (auto on test start when configured)
|
|
264
|
-
zibby memory push # push to remote (auto after passing tests)
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
When `memorySync.remote` is set in `.zibby.config.mjs` (`'hosted'` or an `aws://...` URL), `zibby init` auto-wires the remote on first run — teammates clone, run init, and they're plugged in.
|
|
268
|
-
|
|
269
|
-
## init {#init}
|
|
270
|
-
|
|
271
|
-
```bash
|
|
272
|
-
zibby init [project-name]
|
|
273
|
-
zibby init -t browser-test-automation # also scaffold the test recipe
|
|
274
|
-
```
|
|
275
|
-
|
|
276
|
-
Bare init by default — writes `.zibby.config.mjs`, sets up agent credentials, configures memory. Pass `-t <template>` to also scaffold an agent template into `.zibby/`.
|
|
277
|
-
|
|
278
|
-
Common options:
|
|
279
|
-
- `-t, --template <name>` — agent template to scaffold (see `zibby template list`). Default: none (config + creds only).
|
|
280
|
-
- `--agent <claude|cursor|codex|gemini>` — pick the agent up front instead of prompting
|
|
281
|
-
- `--memory-backend <mem0|dolt>` — memory backend (default: `mem0` — semantic vector memory, billed through the agent run in cloud, falls back to `dolt` if the embedding proxy is unavailable; pass `dolt` for self-contained structured memory — see [Chat memory](./skills/chat-memory.md))
|
|
282
|
-
- `--skip-install` / `--skip-memory` — skip `npm install` / skip memory setup
|
|
283
|
-
- `-f, --force` — overwrite existing config
|
|
284
|
-
- `--api-key <key>` — non-interactive Zibby API key (for `--cloud-sync`)
|
|
285
|
-
- `--cloud-sync` — enable cloud sync and install the Zibby MCP
|
|
286
|
-
|
|
287
|
-
## template {#template}
|
|
288
|
-
|
|
289
|
-
```bash
|
|
290
|
-
zibby template list # see what's available
|
|
291
|
-
zibby template add <name> # copy template into .zibby/ (overwrites = doubles as update)
|
|
292
|
-
```
|
|
293
|
-
|
|
294
|
-
Templates are starter agent scaffolds. `add` overwrites existing files in place — use it to upgrade an outdated agent helpers block, or to grab a recipe you didn't pick at `init` time.
|
|
295
|
-
|
|
296
|
-
`zibby template add zibby-workflow-claude` (or `-cursor`, `-codex`) refreshes the per-agent guidance files emitted by this template — the `<!-- zibby-template-version: N -->` markers make the upgrade idempotent.
|
|
297
|
-
|
|
298
|
-
Options on `add`:
|
|
299
|
-
- `--skip-memory` — strip `SKILLS.MEMORY` from copied `execute-live.mjs` (browser-test template only)
|
|
300
|
-
|
|
301
|
-
## App commands {#app-commands}
|
|
302
|
-
|
|
303
|
-
`zibby app` manages [Managed App instances](./apps/) — hosted open-source tools (Grafana, Open WebUI, Docmost, OpenHands, and 18 more in the catalog, plus anything you install via [goal-mode](./apps/goal-mode)) with an autonomous agent-ops sidecar. Each verb is keyed by **instance ID** (`a1b2c3d4`-style); `zibby app list` shows IDs alongside display names.
|
|
304
|
-
|
|
305
|
-
| Command | What it does |
|
|
306
|
-
|---|---|
|
|
307
|
-
| [`zibby app templates`](#app-templates) | Browse the catalog (grafana, uptime-kuma, open-webui, openhands, docmost, …) |
|
|
308
|
-
| [`zibby app list`](#app-list) | List deployed instances under your account |
|
|
309
|
-
| [`zibby app deploy <appType>`](#app-deploy) | Deploy an app from the catalog, or `--goal "..."` for free-form goal-mode |
|
|
310
|
-
| [`zibby app status <id>`](#app-status) | One-screen summary: status, resources, URL, last agent-ops run |
|
|
311
|
-
| [`zibby app logs <id>`](#app-logs) | Logs from app + agent-ops, with `-t` tail mode; `--service <name>` to scope multi-service |
|
|
312
|
-
| [`zibby app upgrade <id>`](#app-upgrade) | Zero-downtime roll to the catalog's current image |
|
|
313
|
-
| [`zibby app restart <id>`](#app-restart) | Force ECS service to roll the running tasks |
|
|
314
|
-
| [`zibby app set-auth <id>`](#app-set-auth) | Add / rotate / remove the optional Caddy auth proxy |
|
|
315
|
-
| [`zibby app update-credential <id>`](#app-update-credential) | Rotate a BYOK credential and restart |
|
|
316
|
-
| [`zibby app destroy <id>`](#app-destroy) | Tear down service + volume (data permanently deleted) |
|
|
317
|
-
|
|
318
|
-
### app templates {#app-templates}
|
|
319
|
-
|
|
320
|
-
```bash
|
|
321
|
-
zibby app templates
|
|
322
|
-
```
|
|
323
|
-
|
|
324
|
-
Print the live catalog — id, display name, tier, hourly rate, one-line description.
|
|
325
|
-
|
|
326
|
-
### app list {#app-list}
|
|
327
|
-
|
|
328
|
-
```bash
|
|
329
|
-
zibby app list # all instances under your account
|
|
330
|
-
zibby app list --project <id> # scope to one project
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
Options:
|
|
334
|
-
- `--project <id>` — project to scope the listing to (default: all projects your account owns)
|
|
335
|
-
- `--api-key <key>` — API key (or `ZIBBY_API_KEY` env)
|
|
336
|
-
|
|
337
|
-
### app deploy {#app-deploy}
|
|
338
|
-
|
|
339
|
-
```bash
|
|
340
|
-
zibby app deploy grafana --project <project-id> --name metrics
|
|
341
|
-
zibby app deploy --goal "Install n8n on port 5678 with sqlite persistence" --project <id> --name automations
|
|
342
|
-
```
|
|
343
|
-
|
|
344
|
-
Two modes:
|
|
345
|
-
|
|
346
|
-
- **Catalog**: pass an `appType` (slug from `zibby app templates`).
|
|
347
|
-
- **Goal-mode**: pass `--goal "<install description>"` instead of `appType`. Claude writes the install script and agent-ops runs it under supervision inside the container. See [Goal-mode deploys](./apps/goal-mode).
|
|
348
|
-
|
|
349
|
-
Options:
|
|
350
|
-
|
|
351
|
-
- `--project <id>` — interactive picker if omitted
|
|
352
|
-
- `--name <name>` — display name in the dashboard / `zibby app list` (defaults to `appType`)
|
|
353
|
-
- `--provider <name>` — `claude` (default) or `codex` — picks which BYOK credential to inject
|
|
354
|
-
- `--arch <name>` — `x86_64` or `arm64` (defaults to catalog's first listed arch)
|
|
355
|
-
- `--api-key <key>` — Zibby API key (or `ZIBBY_API_KEY` env)
|
|
356
|
-
- `--cpu <units>` — Fargate CPU units (e.g. `1024` for 1 vCPU; default from tier)
|
|
357
|
-
- `--memory <mb>` — Fargate memory in MB (e.g. `2048` for 2 GB; default from tier)
|
|
358
|
-
|
|
359
|
-
Goal-mode + planner options (used by `--goal` deploys and cheatsheet-mode catalog entries):
|
|
360
|
-
|
|
361
|
-
- `--goal "<text>"` — free-form install description. Mutually exclusive with `[appType]`.
|
|
362
|
-
- `--model <name>` — Claude model identifier. E.g. `claude-sonnet-4-6` (default), `claude-opus-4-8`, `claude-haiku-4-5-20251001`. Overrides the agent-ops bootstrap default.
|
|
363
|
-
- `--anthropic-token <token>` — per-deploy Claude credential override. An Anthropic API key (`sk-ant-api03-…`, from [console.anthropic.com](https://console.anthropic.com/settings/keys)). SENSITIVE. Also accepts `ZIBBY_ANTHROPIC_TOKEN` env. Falls back to workspace credentials if absent.
|
|
364
|
-
- `--max-turns <n>` — Claude subprocess max turns, 1-200 (default 25). Bump for heavy installs.
|
|
365
|
-
- `--timeout-min <n>` — bootstrap wall-clock minutes, 1-120 (default 30).
|
|
366
|
-
|
|
367
|
-
Auth proxy options (opts into a Caddy sidecar on port 8888 — see [Auth proxy](./apps/auth)):
|
|
368
|
-
|
|
369
|
-
- `--auth-type <kind>` — `basic`, `token`, or `none` (default `none`).
|
|
370
|
-
- `--auth-user <name>` — required for `--auth-type basic`. Printable ASCII, no spaces, 1-64 chars.
|
|
371
|
-
- `--auth-password <pass>` — required for `--auth-type basic`. SENSITIVE. 8-256 chars. Also accepts `ZIBBY_APP_AUTH_PASSWORD` env.
|
|
372
|
-
- `--auth-token <token>` — optional for `--auth-type token`. If omitted, backend auto-generates a 32-char URL-safe token and returns it ONCE on deploy. Also accepts `ZIBBY_APP_AUTH_TOKEN` env.
|
|
373
|
-
|
|
374
|
-
Returns an `instanceId` and the public URL. If `--auth-type token` was used without `--auth-token`, the generated token is included in the response and shown ONCE — save it then, you can't retrieve it later.
|
|
375
|
-
|
|
376
|
-
### app status {#app-status}
|
|
377
|
-
|
|
378
|
-
```bash
|
|
379
|
-
zibby app status a1b2c3d4
|
|
380
|
-
```
|
|
381
|
-
|
|
382
|
-
Prints status, resources, hourly rate, public URL, and the latest agent-ops run summary.
|
|
383
|
-
|
|
384
|
-
### app logs {#app-logs}
|
|
385
|
-
|
|
386
|
-
```bash
|
|
387
|
-
zibby app logs a1b2c3d4 # last 200 lines
|
|
388
|
-
zibby app logs a1b2c3d4 -t # tail mode, polls every 3s, SSE auto-reconnect
|
|
389
|
-
zibby app logs a1b2c3d4 --lines 1000 # bigger window
|
|
390
|
-
zibby app logs a1b2c3d4 --json # raw JSON lines
|
|
391
|
-
zibby app logs a1b2c3d4 --verbose # full line including JSON body
|
|
392
|
-
zibby app logs a1b2c3d4 -t --service db # scope to one container in a multi-service entry
|
|
393
|
-
```
|
|
394
|
-
|
|
395
|
-
Logs cover **all** containers in the task — the app(s), the agent-ops sidecar, and (if enabled) the Caddy auth proxy — prefixed by source. Default output is the parsed `<time> <msg>` summary.
|
|
396
|
-
|
|
397
|
-
Options:
|
|
398
|
-
|
|
399
|
-
- `-t, --follow` — live tail
|
|
400
|
-
- `--lines <n>` — initial window size (default 200)
|
|
401
|
-
- `--json` / `--verbose` — output format toggles
|
|
402
|
-
- `--service <name>` — scope to one container by name (e.g. `db` on docmost). Useful for multi-service catalog entries.
|
|
403
|
-
|
|
404
|
-
### app upgrade {#app-upgrade}
|
|
405
|
-
|
|
406
|
-
```bash
|
|
407
|
-
zibby app upgrade a1b2c3d4
|
|
408
|
-
zibby app upgrade a1b2c3d4 --version 0.1.16 # pin a specific agent-ops version
|
|
409
|
-
zibby app upgrade a1b2c3d4 --yes # skip confirmation
|
|
410
|
-
```
|
|
411
|
-
|
|
412
|
-
Registers a new task definition revision, updates the ECS service, and lets the ALB drain old tasks before they exit. Zero-downtime for HTTP traffic.
|
|
413
|
-
|
|
414
|
-
### app restart {#app-restart}
|
|
415
|
-
|
|
416
|
-
```bash
|
|
417
|
-
zibby app restart a1b2c3d4
|
|
418
|
-
```
|
|
419
|
-
|
|
420
|
-
Forces the ECS service to roll the current tasks without changing the task definition. Useful when the app gets wedged on a stuck connection.
|
|
421
|
-
|
|
422
|
-
### app set-auth {#app-set-auth}
|
|
423
|
-
|
|
424
|
-
Add, rotate, or remove the [Caddy auth proxy](./apps/auth) on an existing instance.
|
|
425
|
-
|
|
426
|
-
```bash
|
|
427
|
-
# Add basic auth to a previously-unauthenticated instance
|
|
428
|
-
zibby app set-auth a1b2c3d4 --auth-type basic --auth-user admin --auth-password 'S0me-long-passphrase!'
|
|
429
|
-
|
|
430
|
-
# Rotate just the password (basic auth must already be on)
|
|
431
|
-
zibby app set-auth a1b2c3d4 --auth-password 'N3w-passphrase-2026!'
|
|
432
|
-
|
|
433
|
-
# Switch from basic to token auth (caller-supplied)
|
|
434
|
-
zibby app set-auth a1b2c3d4 --auth-type token --auth-token "$(cat ~/.secrets/bearer.txt)"
|
|
435
|
-
|
|
436
|
-
# Switch to token auth with a freshly-generated token (returned ONCE in response)
|
|
437
|
-
zibby app set-auth a1b2c3d4 --auth-type token
|
|
438
|
-
|
|
439
|
-
# Strip auth entirely — Caddy container is removed; ALB routes straight to the app
|
|
440
|
-
zibby app set-auth a1b2c3d4 --off
|
|
441
|
-
```
|
|
442
|
-
|
|
443
|
-
PATCH semantics: omitted flags preserve current state. Triggers an ECS rolling task replace (~60-90s); the app container keeps its EFS data, only the proxy config / container set changes.
|
|
444
|
-
|
|
445
|
-
Options:
|
|
446
|
-
|
|
447
|
-
- `--auth-type <kind>` — `basic`, `token`, or `none`
|
|
448
|
-
- `--auth-user <name>` — required when setting `--auth-type basic`
|
|
449
|
-
- `--auth-password <pass>` — set / rotate the basic-auth password. Also accepts `ZIBBY_APP_AUTH_PASSWORD` env.
|
|
450
|
-
- `--auth-token <token>` — set / rotate the bearer token. If `--auth-type token` is set without this flag, backend generates a 32-char URL-safe token and returns it once. Also accepts `ZIBBY_APP_AUTH_TOKEN` env.
|
|
451
|
-
- `--off` — remove auth entirely. Equivalent to `--auth-type none`.
|
|
452
|
-
- `--yes` — skip confirmation prompt.
|
|
453
|
-
|
|
454
|
-
### app update-credential {#app-update-credential}
|
|
455
|
-
|
|
456
|
-
```bash
|
|
457
|
-
zibby app update-credential a1b2c3d4
|
|
458
|
-
```
|
|
459
|
-
|
|
460
|
-
Picks up whatever's currently in your workspace credentials and rolls the task with the new secret env. EFS data is preserved; the task restarts in ~30s. Used by BYOK apps (e.g. Open WebUI pointing at Anthropic via your own key).
|
|
461
|
-
|
|
462
|
-
### app destroy {#app-destroy}
|
|
463
|
-
|
|
464
|
-
```bash
|
|
465
|
-
zibby app destroy a1b2c3d4 # interactive confirm
|
|
466
|
-
zibby app destroy a1b2c3d4 --yes # skip the confirmation prompt
|
|
467
|
-
```
|
|
468
|
-
|
|
469
|
-
Drains the ECS service, deletes the task definition revision, removes the ALB listener rule + target group, releases the EFS access point (**destroying the volume data permanently**), and stops the billing meter immediately. No soft delete.
|
|
470
|
-
|
|
471
|
-
## Environment variables
|
|
472
|
-
|
|
473
|
-
| Var | Purpose |
|
|
474
|
-
|---|---|
|
|
475
|
-
| `ZIBBY_API_KEY` | API key for non-interactive auth (CI). Preferred over saved session. |
|
|
476
|
-
| `ZIBBY_PROJECT_ID` | Default project for commands that take `--project` |
|
|
477
|
-
| `AGENT_TYPE` | Default agent strategy when no per-node override and no project default |
|
|
478
|
-
| `ZIBBY_DEPLOY_VERBOSE=1` | Same as `--verbose` on `agent deploy` |
|
|
479
|
-
| `ZIBBY_SESSION_LOG=1` | Re-enable the diagnostic `[zibby:session]` log line in run output |
|
|
480
|
-
| `ZIBBY_RUN_DIAG=1` | Cloud runtime: dump per-copy `agent-workflow` registry state |
|
|
481
|
-
| `ZIBBY_DEBUG=true` | Verbose debug logs from the framework |
|
|
482
|
-
|
|
483
|
-
## Legacy aliases
|
|
484
|
-
|
|
485
|
-
These still work and route to the same handlers, but new code should use the `zibby agent <verb>` form. The `zibby workflow <verb>` namespace also remains a full alias for `zibby agent <verb>`:
|
|
486
|
-
|
|
487
|
-
| Legacy | Canonical |
|
|
488
|
-
|---|---|
|
|
489
|
-
| `zibby g workflow <name>` | `zibby agent new <name>` |
|
|
490
|
-
| `zibby start <name>` | `zibby agent start <name>` |
|
|
491
|
-
| `zibby run <name>` | `zibby agent run <name>` |
|
|
492
|
-
| `zibby deploy [name]` | `zibby agent deploy [name]` |
|
|
493
|
-
| `zibby trigger <uuid>` | `zibby agent trigger <uuid>` |
|
|
494
|
-
| `zibby logs <uuid>` | `zibby agent logs <uuid>` |
|