@zibby/skills 0.1.33 → 0.1.35
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 +2 -0
- package/dist/browser.d.ts +19 -0
- package/dist/chat-memory.d.ts +355 -0
- package/dist/chat-notify.d.ts +409 -0
- package/dist/core-tools.d.ts +131 -0
- package/dist/function-skill.d.ts +149 -0
- package/dist/git.d.ts +72 -0
- package/dist/github.d.ts +777 -0
- package/dist/github.js +4 -3
- package/dist/gitlab.d.ts +396 -0
- package/dist/gitlab.js +19 -0
- package/dist/index.d.ts +45 -0
- package/dist/index.js +145 -126
- package/dist/integrations.d.ts +110 -0
- package/dist/jira.d.ts +547 -0
- package/dist/lark.d.ts +161 -0
- package/dist/linear.d.ts +344 -0
- package/dist/llm-billing.d.ts +294 -0
- package/dist/memory.d.ts +137 -0
- package/dist/package.json +67 -17
- package/dist/plane.d.ts +24 -0
- package/dist/report.d.ts +354 -0
- package/dist/report.js +9 -9
- package/dist/sentry.d.ts +43 -0
- package/dist/skill-installer.d.ts +86 -0
- package/dist/slack.d.ts +284 -0
- package/dist/test-runner.d.ts +220 -0
- package/dist/trackers/github-adapter.d.ts +96 -0
- package/dist/trackers/github-adapter.js +4 -3
- package/dist/trackers/index.d.ts +27 -0
- package/dist/trackers/index.js +16 -15
- package/dist/trackers/jira-adapter.d.ts +90 -0
- package/dist/trackers/linear-adapter.d.ts +89 -0
- package/dist/trackers/plane-adapter.d.ts +101 -0
- package/dist/trackers/types.d.ts +335 -0
- package/dist/workflow-builder.d.ts +245 -0
- package/docs/apps/agent-ops.md +6 -6
- package/docs/apps/deploy.md +1 -1
- package/docs/apps/index.md +1 -1
- package/docs/apps/managing.md +1 -1
- package/docs/cli-reference.md +65 -65
- package/docs/cloning-repositories.md +9 -9
- package/docs/cloud/bundles.md +8 -8
- package/docs/cloud/dedicated-egress.md +6 -6
- package/docs/cloud/env-vars.md +29 -29
- package/docs/cloud/limits.md +11 -11
- package/docs/cloud/triggering.md +16 -16
- package/docs/concepts/agents.md +4 -4
- package/docs/concepts/sessions.md +7 -7
- package/docs/concepts/state.md +1 -1
- package/docs/concepts/sub-graphs.md +9 -9
- package/docs/get-started/deploy.md +14 -14
- package/docs/get-started/install.md +4 -4
- package/docs/get-started/run-locally.md +12 -12
- package/docs/get-started/trigger-and-logs.md +14 -14
- package/docs/get-started/use-from-agents.md +17 -17
- package/docs/get-started/your-first-workflow.md +8 -8
- package/docs/integrations/gitlab.md +1 -1
- package/docs/integrations/lark.md +2 -2
- package/docs/integrations/linear.md +1 -1
- package/docs/integrations/notion.md +2 -2
- package/docs/integrations/plane.md +1 -1
- package/docs/integrations/slack.md +1 -1
- package/docs/intro.md +4 -4
- package/docs/legacy/test-automation.md +2 -2
- package/docs/packages/cli.md +11 -11
- package/docs/packages/core.md +2 -2
- package/docs/packages/mcp-cli.md +18 -18
- package/docs/packages/skills.md +2 -2
- package/docs/packages/ui-memory.md +1 -1
- package/docs/recipes/bug-autofix.md +1 -1
- package/docs/recipes/index.md +3 -3
- package/docs/recipes/pipeline-supervisor.md +4 -4
- package/docs/recipes/sentry-triage.md +7 -7
- package/docs/recipes/test.md +6 -6
- package/docs/skills/browser.md +2 -2
- package/docs/skills/chat-memory.md +1 -1
- package/docs/skills/core-tools.md +1 -1
- package/docs/skills/function-skill.md +1 -1
- package/docs/skills/github.md +2 -2
- package/docs/skills/index.md +1 -1
- package/docs/skills/jira.md +1 -1
- package/docs/skills/lark.md +1 -1
- package/docs/skills/memory.md +2 -2
- package/docs/skills/sentry.md +1 -1
- package/docs/skills/slack.md +2 -2
- package/package.json +67 -17
|
@@ -5,34 +5,34 @@ pagination_prev: get-started/run-locally
|
|
|
5
5
|
pagination_next: get-started/trigger-and-logs
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
# Ship
|
|
8
|
+
# Ship an agent to Zibby Cloud
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
|
-
zibby
|
|
11
|
+
zibby agent deploy my-agent
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
If you have multiple projects, the CLI prompts you to pick one. On success it prints a UUID:
|
|
15
15
|
|
|
16
16
|
```
|
|
17
|
-
✔ Deployed my-
|
|
17
|
+
✔ Deployed my-agent (v1)
|
|
18
18
|
✔ Bundle ready (78s) — runtime npm install eliminated
|
|
19
19
|
|
|
20
20
|
UUID: 2b1ea07f-3ede-4bfd-a51d-431f0bab008e
|
|
21
21
|
|
|
22
22
|
Next steps:
|
|
23
|
-
zibby
|
|
24
|
-
zibby
|
|
25
|
-
zibby
|
|
23
|
+
zibby agent run my-agent Run locally
|
|
24
|
+
zibby agent trigger 2b1ea07f-... Run in cloud
|
|
25
|
+
zibby agent list View all agents
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
The UUID is **canonical** — it never changes once issued. All cloud commands (`trigger`, `logs`, `download`, `delete`) take that UUID as their identifier. The CLI caches it in `.zibby/workflows/my-
|
|
28
|
+
The UUID is **canonical** — it never changes once issued. All cloud commands (`trigger`, `logs`, `download`, `delete`) take that UUID as their identifier. The CLI caches it in `.zibby/workflows/my-agent/.zibby-deploy.json` so you don't have to remember it. Commit that file to git; collaborators share the same canonical reference.
|
|
29
29
|
|
|
30
30
|
## What deploy actually does
|
|
31
31
|
|
|
32
32
|
Two phases:
|
|
33
33
|
|
|
34
|
-
1. **Source upload** — your
|
|
35
|
-
2. **Bundle build (Heroku-style)** — a CodeBuild job downloads the sources, runs `npm install --omit=dev`, packages the result as a tarball, and uploads it to S3. The tarball is what each cloud execution downloads at trigger time, so there's **no `npm install` at runtime** —
|
|
34
|
+
1. **Source upload** — your agent folder (sources only, no `node_modules`) is uploaded as a JSON payload to S3 via a presigned URL. The CLI also resolves your `.zibby.config.mjs` (if present at project root) and ships it inside the bundle as `zibby.config.json`, so the cloud sees the same config as your local runs.
|
|
35
|
+
2. **Bundle build (Heroku-style)** — a CodeBuild job downloads the sources, runs `npm install --omit=dev`, packages the result as a tarball, and uploads it to S3. The tarball is what each cloud execution downloads at trigger time, so there's **no `npm install` at runtime** — agents boot in seconds.
|
|
36
36
|
|
|
37
37
|
You'll see a live spinner with the active build step:
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ Pass `--verbose` if you want to see raw CodeBuild logs.
|
|
|
44
44
|
|
|
45
45
|
## Re-deploys keep the same UUID
|
|
46
46
|
|
|
47
|
-
Once
|
|
47
|
+
Once an agent has a UUID, every subsequent `deploy` increments the version but keeps the UUID stable:
|
|
48
48
|
|
|
49
49
|
```
|
|
50
50
|
v1 → v2 → v3 → ... (same UUID, same trigger URL)
|
|
@@ -56,20 +56,20 @@ So your `curl` calls and CI integrations don't break across deploys.
|
|
|
56
56
|
|
|
57
57
|
A clean mental model:
|
|
58
58
|
|
|
59
|
-
- **
|
|
59
|
+
- **Agent folder name** (`my-agent`) is *local* — used by `agent new`, `start`, `deploy`. It's just a directory name.
|
|
60
60
|
- **UUID** (`2b1ea07f-...`) is *canonical* — used by `trigger`, `logs`, `download`, `delete`. Stable across deploys.
|
|
61
61
|
|
|
62
|
-
`
|
|
62
|
+
`agent list` shows both:
|
|
63
63
|
|
|
64
64
|
```
|
|
65
65
|
┌─────────────────────────────────────┬──────────────┬──────────┬─────┐
|
|
66
66
|
│ UUID │ Name │ Project │ Ver │
|
|
67
67
|
├─────────────────────────────────────┼──────────────┼──────────┼─────┤
|
|
68
|
-
│ 2b1ea07f-3ede-4bfd-a51d-431f0bab008e│ my-
|
|
68
|
+
│ 2b1ea07f-3ede-4bfd-a51d-431f0bab008e│ my-agent │ Zibby UI │ 3 │
|
|
69
69
|
│ - │ scratchpad │ - │ - │
|
|
70
70
|
└─────────────────────────────────────┴──────────────┴──────────┴─────┘
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
`-` in the UUID column means a local-only
|
|
73
|
+
`-` in the UUID column means a local-only agent that hasn't been deployed yet.
|
|
74
74
|
|
|
75
75
|
→ Next: [Trigger & tail logs](./trigger-and-logs)
|
|
@@ -7,7 +7,7 @@ pagination_next: get-started/your-first-workflow
|
|
|
7
7
|
|
|
8
8
|
# Install the CLI
|
|
9
9
|
|
|
10
|
-
You build **Agents** with Zibby — deployed automations
|
|
10
|
+
You build **Agents** with Zibby — deployed automations. The CLI command is `zibby agent`.
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
13
|
npm install -g @zibby/cli
|
|
@@ -26,7 +26,7 @@ You should see something like `zibby v0.4.x`.
|
|
|
26
26
|
Every example below works with `npx @zibby/cli` instead of `zibby`:
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
|
-
npx @zibby/cli
|
|
29
|
+
npx @zibby/cli agent new my-agent
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
The first call downloads the package; subsequent calls use the cached copy.
|
|
@@ -45,7 +45,7 @@ For CI/CD, set `ZIBBY_API_KEY` in the environment instead — the CLI prefers th
|
|
|
45
45
|
|
|
46
46
|
## Pick an agent runtime
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
Agents hand off to external coding-agent CLIs at runtime. You'll need at least one of these installed (locally — the cloud runtime has them pre-installed):
|
|
49
49
|
|
|
50
50
|
| Agent | How to install | Auth |
|
|
51
51
|
|---|---|---|
|
|
@@ -57,4 +57,4 @@ Workflows hand off to external coding-agent CLIs at runtime. You'll need at leas
|
|
|
57
57
|
|
|
58
58
|
You only need one. The cloud runtime supports all five out of the box.
|
|
59
59
|
|
|
60
|
-
→ Next: [Your first
|
|
60
|
+
→ Next: [Your first agent](./your-first-workflow)
|
|
@@ -5,10 +5,10 @@ pagination_prev: get-started/your-first-workflow
|
|
|
5
5
|
pagination_next: get-started/deploy
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
# Run
|
|
8
|
+
# Run an agent locally
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
|
-
zibby
|
|
11
|
+
zibby agent run my-agent
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
One-shot: loads `graph.mjs`, instantiates your `WorkflowAgent` class, runs the graph against a real agent, prints results, exits. Output lands in `.zibby/output/sessions/<sessionId>/`:
|
|
@@ -18,11 +18,11 @@ One-shot: loads `graph.mjs`, instantiates your `WorkflowAgent` class, runs the g
|
|
|
18
18
|
- `events.json` — JSONL execution log: which node ran when, what it received, what it returned, retries
|
|
19
19
|
- `.session-info.json` — session metadata
|
|
20
20
|
|
|
21
|
-
The flag surface mirrors `zibby
|
|
21
|
+
The flag surface mirrors `zibby agent trigger` (cloud) on purpose: the call you make locally is the same call you make against the cloud, just with the verb flipped.
|
|
22
22
|
|
|
23
23
|
## Pass input
|
|
24
24
|
|
|
25
|
-
Most
|
|
25
|
+
Most agents take input. Edit `graph.mjs` to define an input schema and reference `state.input`:
|
|
26
26
|
|
|
27
27
|
```js
|
|
28
28
|
graph.addNode('plan', {
|
|
@@ -35,14 +35,14 @@ graph.addNode('plan', {
|
|
|
35
35
|
Then pass input via `--input`:
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
zibby
|
|
38
|
+
zibby agent run my-agent --input '{"ticket":"BUG-123"}'
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
Or `--param key=value` (repeatable, dot-notation supported):
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
zibby
|
|
45
|
-
zibby
|
|
44
|
+
zibby agent run my-agent -p ticket=BUG-123 -p priority=high
|
|
45
|
+
zibby agent run my-agent -p user.name=Alice -p user.role=admin
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
Or `--input-file payload.json` for larger payloads.
|
|
@@ -56,15 +56,15 @@ Each run is a fresh process — re-edit `graph.mjs` or any node file and re-run.
|
|
|
56
56
|
If you want auto-rerun on file change, run it under `nodemon`:
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
|
-
npx nodemon --ext mjs,js --exec "zibby
|
|
59
|
+
npx nodemon --ext mjs,js --exec "zibby agent run my-agent -p ticket=BUG-123"
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Or add it to your
|
|
62
|
+
Or add it to your agent's `package.json`:
|
|
63
63
|
|
|
64
64
|
```json
|
|
65
65
|
{
|
|
66
66
|
"scripts": {
|
|
67
|
-
"dev": "nodemon --ext mjs,js --exec \"zibby
|
|
67
|
+
"dev": "nodemon --ext mjs,js --exec \"zibby agent run my-agent\""
|
|
68
68
|
}
|
|
69
69
|
}
|
|
70
70
|
```
|
|
@@ -85,10 +85,10 @@ cat .zibby/output/sessions/<sessionId>/result.json | jq
|
|
|
85
85
|
Studio is a desktop UI for browsing live + past runs. It connects to a local HTTP server, so when you use Studio you start that instead:
|
|
86
86
|
|
|
87
87
|
```bash
|
|
88
|
-
zibby
|
|
88
|
+
zibby agent start my-agent # long-lived server on :3848 (Studio talks to this)
|
|
89
89
|
zibby studio # launch the desktop app
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
For CLI-only iteration, stick with `zibby
|
|
92
|
+
For CLI-only iteration, stick with `zibby agent run`.
|
|
93
93
|
|
|
94
94
|
→ Next: [Deploy to cloud](./deploy)
|
|
@@ -4,12 +4,12 @@ title: 5. Trigger & tail logs
|
|
|
4
4
|
pagination_prev: get-started/deploy
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
# Run a deployed
|
|
7
|
+
# Run a deployed agent and watch logs
|
|
8
8
|
|
|
9
9
|
## Trigger
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
zibby
|
|
12
|
+
zibby agent trigger 2b1ea07f-3ede-4bfd-a51d-431f0bab008e
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
The CLI returns immediately with a job ID:
|
|
@@ -24,24 +24,24 @@ The CLI returns immediately with a job ID:
|
|
|
24
24
|
Triggered: 02/05/2026, 10:23:13
|
|
25
25
|
|
|
26
26
|
Monitor execution:
|
|
27
|
-
zibby
|
|
28
|
-
zibby
|
|
27
|
+
zibby agent logs 2b1ea07f-...
|
|
28
|
+
zibby agent logs 2b1ea07f-... -t
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
Pass input the same way as locally:
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
|
-
zibby
|
|
35
|
-
zibby
|
|
36
|
-
zibby
|
|
34
|
+
zibby agent trigger <uuid> -p ticket=BUG-123
|
|
35
|
+
zibby agent trigger <uuid> --input '{"ticket":"BUG-123"}'
|
|
36
|
+
zibby agent trigger <uuid> --input-file ./input.json
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
If you omit the UUID, the CLI shows an interactive picker over your deployed
|
|
39
|
+
If you omit the UUID, the CLI shows an interactive picker over your deployed agents.
|
|
40
40
|
|
|
41
41
|
## Tail logs (Heroku-style)
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
zibby
|
|
44
|
+
zibby agent logs 2b1ea07f-3ede-4bfd-a51d-431f0bab008e -t
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
`-t` follows live. Without `-t` it dumps the last execution and exits.
|
|
@@ -52,7 +52,7 @@ zibby workflow logs 2b1ea07f-3ede-4bfd-a51d-431f0bab008e -t
|
|
|
52
52
|
|
|
53
53
|
2026-05-02 23:30:51.345 zibby v0.4.x
|
|
54
54
|
────────────────────────────────────────────────────────────
|
|
55
|
-
Workflow: my-
|
|
55
|
+
Workflow: my-agent
|
|
56
56
|
Job: ee333411-...
|
|
57
57
|
Project: 6b60049d-...
|
|
58
58
|
Agent: cursor (model: auto)
|
|
@@ -65,24 +65,24 @@ zibby workflow logs 2b1ea07f-3ede-4bfd-a51d-431f0bab008e -t
|
|
|
65
65
|
│ ◆ Model: auto | key: ***bc97
|
|
66
66
|
│ ...
|
|
67
67
|
└ done 19.4s
|
|
68
|
-
[done] my-
|
|
68
|
+
[done] my-agent completed in 19.4s
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
The stream covers the full execution end-to-end — agent reasoning, tool calls, schema validation, completion summary.
|
|
72
72
|
|
|
73
73
|
## Multiple executions
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
Agent UUIDs follow the agent, not a single run. After one execution finishes, `logs -t` waits for the next trigger of the same agent and auto-switches to streaming it. Like `heroku logs --tail`.
|
|
76
76
|
|
|
77
77
|
To exit after the current run, just Ctrl+C — there's no "exit on completion" mode (yet).
|
|
78
78
|
|
|
79
79
|
## Triggering from anywhere
|
|
80
80
|
|
|
81
|
-
The CLI is the easiest way, but
|
|
81
|
+
The CLI is the easiest way, but agents expose an HTTP API for programmatic triggering — see [Cloud → Triggering programmatically](../cloud/triggering).
|
|
82
82
|
|
|
83
83
|
## You're done
|
|
84
84
|
|
|
85
|
-
You've now scaffolded, run locally, deployed, triggered, and tailed
|
|
85
|
+
You've now scaffolded, run locally, deployed, triggered, and tailed an agent. The rest of the docs go deeper:
|
|
86
86
|
|
|
87
87
|
- [Concepts](../concepts/graph) — how the graph engine works
|
|
88
88
|
- [CLI Reference](../cli-reference) — every command
|
|
@@ -6,13 +6,13 @@ pagination_prev: get-started/trigger-and-logs
|
|
|
6
6
|
|
|
7
7
|
# Use Zibby from Claude Code, Cursor, Codex, or Gemini
|
|
8
8
|
|
|
9
|
-
Zibby ships an MCP (Model Context Protocol) server — [`@zibby/mcp-cli`](../packages/mcp-cli). Add it once to your agent's config and Zibby becomes a first-class tool the agent can call directly from chat. Deploy
|
|
9
|
+
Zibby ships an MCP (Model Context Protocol) server — [`@zibby/mcp-cli`](../packages/mcp-cli). Add it once to your agent's config and Zibby becomes a first-class tool the agent can call directly from chat. Deploy agents, trigger runs, tail logs — all without leaving your editor.
|
|
10
10
|
|
|
11
11
|
```
|
|
12
12
|
You: Deploy the browser-test template to my Playhouse project, then run it.
|
|
13
|
-
Agent: →
|
|
14
|
-
→
|
|
15
|
-
→
|
|
13
|
+
Agent: → zibby_scaffold_agent
|
|
14
|
+
→ zibby_deploy_agent
|
|
15
|
+
→ zibby_trigger_agent
|
|
16
16
|
→ "Done. Job a23e… completed in 47s, 0 failures."
|
|
17
17
|
```
|
|
18
18
|
|
|
@@ -109,14 +109,14 @@ Login state lives in `~/.zibby/config.json` (mode `0600`) — the same file the
|
|
|
109
109
|
|
|
110
110
|
| Read-only | Write |
|
|
111
111
|
|---|---|
|
|
112
|
-
| List projects | Scaffold
|
|
113
|
-
| List official templates | Deploy
|
|
114
|
-
| List
|
|
115
|
-
| Show login status | Run
|
|
116
|
-
| Fetch logs from a run | Download a deployed
|
|
117
|
-
| Static-validate
|
|
112
|
+
| List projects | Scaffold an agent from an official template |
|
|
113
|
+
| List official templates | Deploy an agent to a project |
|
|
114
|
+
| List agents (local + remote) | Trigger a deployed agent |
|
|
115
|
+
| Show login status | Run an agent locally (debug) |
|
|
116
|
+
| Fetch logs from a run | Download a deployed agent (with explicit user confirmation) |
|
|
117
|
+
| Static-validate an agent | |
|
|
118
118
|
|
|
119
|
-
**Destructive operations stay out of the agent's hands** —
|
|
119
|
+
**Destructive operations stay out of the agent's hands** — agent delete, env-var changes, schedule mutation, and credential management require you to run `zibby` in a terminal. Two-stage authorization for anything that could surprise you.
|
|
120
120
|
|
|
121
121
|
See the [`@zibby/mcp-cli` package reference](../packages/mcp-cli) for the full tool list and security model.
|
|
122
122
|
|
|
@@ -131,22 +131,22 @@ Agent: → zibby_list_templates
|
|
|
131
131
|
- code-analysis: Jira ticket → analyze → generate code → emit tests
|
|
132
132
|
- generate-test-cases: code diff → prioritized AI-runnable test specs"
|
|
133
133
|
|
|
134
|
-
You: Scaffold generate-test-cases into a new
|
|
134
|
+
You: Scaffold generate-test-cases into a new agent called "release-tests" in my Playhouse project.
|
|
135
135
|
|
|
136
136
|
Agent: → zibby_list_projects (resolves "Playhouse" → projectId)
|
|
137
|
-
→
|
|
138
|
-
→
|
|
137
|
+
→ zibby_scaffold_agent name=release-tests template=generate-test-cases
|
|
138
|
+
→ zibby_validate_agent name=release-tests
|
|
139
139
|
"Scaffolded and validated. Ready to deploy."
|
|
140
140
|
|
|
141
141
|
You: Deploy it.
|
|
142
142
|
|
|
143
|
-
Agent: →
|
|
143
|
+
Agent: → zibby_deploy_agent name=release-tests projectId=…
|
|
144
144
|
"Deployed v1 — UUID 33039db5-2f32-4094-9841-317bc56a88c9."
|
|
145
145
|
|
|
146
146
|
You: Run it against this PR diff: ‹pastes diff›
|
|
147
147
|
|
|
148
|
-
Agent: →
|
|
149
|
-
→
|
|
148
|
+
Agent: → zibby_trigger_agent uuid=33039db5… input={diff: "...", changedFiles: [...]}
|
|
149
|
+
→ zibby_agent_logs jobId=c62e97a4… lines=100
|
|
150
150
|
"Run completed in 1m 23s. Generated 7 test specs (4 Critical, 2 High, 1 Medium)."
|
|
151
151
|
```
|
|
152
152
|
|
|
@@ -1,33 +1,33 @@
|
|
|
1
1
|
---
|
|
2
2
|
sidebar_position: 2
|
|
3
|
-
title: 2. Your first
|
|
3
|
+
title: 2. Your first agent
|
|
4
4
|
pagination_prev: get-started/install
|
|
5
5
|
pagination_next: get-started/run-locally
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Scaffold your first agent
|
|
9
9
|
|
|
10
|
-
An **Agent** is a deployed automation
|
|
10
|
+
An **Agent** is a deployed automation. Scaffold one with the CLI with the `zibby agent` CLI:
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
zibby agent new my-
|
|
14
|
-
# zibby
|
|
13
|
+
zibby agent new my-agent
|
|
14
|
+
# zibby agent new my-agent # alias — identical
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
This creates:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
.zibby/workflows/my-
|
|
20
|
+
.zibby/workflows/my-agent/
|
|
21
21
|
├── graph.mjs # the workflow definition (entry point)
|
|
22
22
|
├── nodes/
|
|
23
23
|
│ └── example.mjs # a sample node
|
|
24
|
-
├── package.json #
|
|
24
|
+
├── package.json # agent's own deps (each agent is a self-contained npm project)
|
|
25
25
|
└── workflow.json # manifest (workflow name, entry class)
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
If `.zibby/workflows/` doesn't exist yet, the scaffold creates it. If you have a `.zibby.config.mjs` with a custom `paths.workflows`, the scaffold respects it.
|
|
29
29
|
|
|
30
|
-
The first time you run this in a fresh directory, you'll be asked where to keep
|
|
30
|
+
The first time you run this in a fresh directory, you'll be asked where to keep agents (default: `.zibby/workflows`). The CLI also runs `npm install` inside the new agent folder so deps are ready.
|
|
31
31
|
|
|
32
32
|
## What's in graph.mjs
|
|
33
33
|
|
|
@@ -64,6 +64,6 @@ The shape is:
|
|
|
64
64
|
|
|
65
65
|
## Picking the agent
|
|
66
66
|
|
|
67
|
-
Each node can specify its own agent via `agent: 'cursor' | 'claude' | 'codex' | 'gemini' | 'assistant'`. If you omit it, the
|
|
67
|
+
Each node can specify its own agent via `agent: 'cursor' | 'claude' | 'codex' | 'gemini' | 'assistant'`. If you omit it, the agent falls back to the project default (set in `.zibby.config.mjs` or `AGENT_TYPE` env var).
|
|
68
68
|
|
|
69
69
|
→ Next: [Run it locally](./run-locally)
|
|
@@ -30,7 +30,7 @@ Nodes that attach the [`gitlab` skill](../skills/index.md) get tools for repos,
|
|
|
30
30
|
|
|
31
31
|
## Reference keys (SDK / CLI)
|
|
32
32
|
|
|
33
|
-
When running
|
|
33
|
+
When running agents directly, the connector reads `GITLAB_TOKEN` (and a base URL for self-hosted instances) from the environment.
|
|
34
34
|
|
|
35
35
|
## Firewalled instances
|
|
36
36
|
|
|
@@ -9,7 +9,7 @@ Connect a Lark (Feishu) self-built app so your agents can send messages, reply,
|
|
|
9
9
|
|
|
10
10
|
## How It Works
|
|
11
11
|
|
|
12
|
-
You create a self-built app in the Lark Developer Console and paste its App ID and App Secret into Zibby. Optionally add a Verification Token and Encrypt Key if you want inbound Lark events to trigger Zibby
|
|
12
|
+
You create a self-built app in the Lark Developer Console and paste its App ID and App Secret into Zibby. Optionally add a Verification Token and Encrypt Key if you want inbound Lark events to trigger Zibby agents. The `lark` skill then exposes Lark's API to any node that declares it.
|
|
13
13
|
|
|
14
14
|
## Connect Lark
|
|
15
15
|
|
|
@@ -32,7 +32,7 @@ Nodes that attach the [`lark` skill](../skills/lark.md) get `lark_send_message`,
|
|
|
32
32
|
|
|
33
33
|
## Inbound events
|
|
34
34
|
|
|
35
|
-
Adding the Verification Token (and Encrypt Key, if enabled) lets Lark events fire your Zibby
|
|
35
|
+
Adding the Verification Token (and Encrypt Key, if enabled) lets Lark events fire your Zibby agents. Leave them blank for outbound-only (notifications).
|
|
36
36
|
|
|
37
37
|
## Troubleshooting
|
|
38
38
|
|
|
@@ -34,7 +34,7 @@ Once connected, nodes that attach the [`linear` skill](../skills/index.md) get t
|
|
|
34
34
|
|
|
35
35
|
## Reference key (SDK / CLI)
|
|
36
36
|
|
|
37
|
-
When running
|
|
37
|
+
When running agents directly (local or CI), the same connector reads from the `LINEAR_API_KEY` environment variable instead of the dashboard-stored credential.
|
|
38
38
|
|
|
39
39
|
## Troubleshooting
|
|
40
40
|
|
|
@@ -20,11 +20,11 @@ You authorize Zibby against a Notion workspace via OAuth. Notion returns a long-
|
|
|
20
20
|
|
|
21
21
|
## What Agents Can Do
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Agents can render a `report` object straight to Notion blocks (`reportToNotionBlocks`) and publish it to a connected page or database — the same digest you can route to Slack or Lark. The `notify-notion` template is the shipped example.
|
|
24
24
|
|
|
25
25
|
## Reference key (SDK / CLI)
|
|
26
26
|
|
|
27
|
-
When running
|
|
27
|
+
When running agents directly, the connector reads `NOTION_API_KEY` from the environment (a Notion internal-integration token works for the SDK path).
|
|
28
28
|
|
|
29
29
|
## Troubleshooting
|
|
30
30
|
|
|
@@ -33,7 +33,7 @@ Nodes that attach the [`plane` skill](../skills/index.md) get tools for projects
|
|
|
33
33
|
|
|
34
34
|
## Reference keys (SDK / CLI)
|
|
35
35
|
|
|
36
|
-
When running
|
|
36
|
+
When running agents directly, the connector reads `PLANE_API_KEY`, `PLANE_WORKSPACE_SLUG`, and `PLANE_BASE_URL` from the environment.
|
|
37
37
|
|
|
38
38
|
## Pairs well with hosted Plane
|
|
39
39
|
|
|
@@ -24,7 +24,7 @@ Nodes that attach the [`slack` skill](../skills/slack.md) get tools to list chan
|
|
|
24
24
|
|
|
25
25
|
## Reference (SDK / CLI)
|
|
26
26
|
|
|
27
|
-
When running
|
|
27
|
+
When running agents directly, the connector reads the bot token and team ID from the environment.
|
|
28
28
|
|
|
29
29
|
## Troubleshooting
|
|
30
30
|
|
package/docs/intro.md
CHANGED
|
@@ -9,7 +9,7 @@ pagination_next: get-started/install
|
|
|
9
9
|
|
|
10
10
|
**The cloud platform for AI agents — built on Claude Code, Cursor, Codex, and Gemini.** Compose real coding-agent CLIs into structured agents with Zod-validated handoff between nodes, then deploy them to the cloud. Vendor-neutral. JavaScript-first.
|
|
11
11
|
|
|
12
|
-
> **
|
|
12
|
+
> An **Agent** is a deployed automation — a graph of coding-agent CLI calls with Zod-typed handoff between nodes. Build and ship one with the `zibby agent` CLI.
|
|
13
13
|
|
|
14
14
|
```
|
|
15
15
|
┌──────────┐ ┌──────────┐ ┌──────────┐
|
|
@@ -29,7 +29,7 @@ graph
|
|
|
29
29
|
|
|
30
30
|
## Try it now
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Get started in seconds:
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
35
|
npm install -g @zibby/cli
|
|
@@ -55,7 +55,7 @@ zibby template add <name> # add a template later (overwrites =
|
|
|
55
55
|
|
|
56
56
|
## What you get
|
|
57
57
|
|
|
58
|
-
- **Multi-vendor** — mix Claude Code + Codex + Cursor + Gemini in one
|
|
58
|
+
- **Multi-vendor** — mix Claude Code + Codex + Cursor + Gemini in one agent. Anthropic will never help you orchestrate Codex; multi-vendor neutrality is structural.
|
|
59
59
|
- **Schema-enforced handoff** — Zod validates every node's output before the next runs. No prompt-stuffing.
|
|
60
60
|
- **Run anywhere** — local with hot reload, or cloud with Heroku-style bundles (~3s cold start).
|
|
61
61
|
- **Session replay** — every run lands as on-disk JSONL + artifacts. Re-run any node via `--session <id> --node <name>`.
|
|
@@ -72,7 +72,7 @@ zibby template add <name> # add a template later (overwrites =
|
|
|
72
72
|
| Billing | Per execution | Per minute, while running |
|
|
73
73
|
| Best for | "When ticket lands, classify it" | "Host Grafana for the team" |
|
|
74
74
|
|
|
75
|
-
An **Agent** is a deployed automation
|
|
75
|
+
An **Agent** is a deployed automation. An **App** is a hosted open-source application. Pick by how long the thing needs to run — see [Apps overview](./apps/) for the decision tree.
|
|
76
76
|
|
|
77
77
|
## How it compares
|
|
78
78
|
|
|
@@ -63,7 +63,7 @@ npx playwright test tests/login.spec.js
|
|
|
63
63
|
|
|
64
64
|
## Customizing Your Setup (Optional)
|
|
65
65
|
|
|
66
|
-
If you want to customize the
|
|
66
|
+
If you want to customize the agent, config, or nodes:
|
|
67
67
|
|
|
68
68
|
```bash
|
|
69
69
|
zibby init --agent cursor
|
|
@@ -82,7 +82,7 @@ This scaffolds:
|
|
|
82
82
|
└── result-handler.js # Post-execution hooks
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
Without `zibby init`, the CLI uses the built-in default
|
|
85
|
+
Without `zibby init`, the CLI uses the built-in default agent automatically.
|
|
86
86
|
|
|
87
87
|
## Environment Variables
|
|
88
88
|
|
package/docs/packages/cli.md
CHANGED
|
@@ -16,18 +16,18 @@ zibby --version
|
|
|
16
16
|
|
|
17
17
|
## What it does
|
|
18
18
|
|
|
19
|
-
- **Scaffolds**
|
|
20
|
-
- **Runs**
|
|
21
|
-
- **Deploys** to Zibby Cloud (Heroku-style bundles): `zibby
|
|
22
|
-
- **Triggers** deployed
|
|
23
|
-
- **Tails** logs: `zibby
|
|
19
|
+
- **Scaffolds** agents: `zibby agent new <name>`
|
|
20
|
+
- **Runs** agents locally (one-shot): `zibby agent run <name>`
|
|
21
|
+
- **Deploys** to Zibby Cloud (Heroku-style bundles): `zibby agent deploy <name>`
|
|
22
|
+
- **Triggers** deployed agents: `zibby agent trigger <uuid>`
|
|
23
|
+
- **Tails** logs: `zibby agent logs <uuid> -t`
|
|
24
24
|
- **Manages** auth: `zibby login`, `zibby logout`, `zibby status`
|
|
25
25
|
|
|
26
26
|
The full command catalog lives at [CLI Reference](../cli-reference).
|
|
27
27
|
|
|
28
|
-
## Self-contained
|
|
28
|
+
## Self-contained agent projects
|
|
29
29
|
|
|
30
|
-
`zibby
|
|
30
|
+
`zibby agent new` creates an agent as a **self-contained npm project** — its own `package.json`, its own `node_modules`. So an agent can pull in arbitrary deps (PDF libraries, custom MCP servers, your own SDK) without polluting the parent project.
|
|
31
31
|
|
|
32
32
|
```
|
|
33
33
|
my-app/
|
|
@@ -35,14 +35,14 @@ my-app/
|
|
|
35
35
|
├── src/
|
|
36
36
|
└── .zibby/
|
|
37
37
|
└── workflows/
|
|
38
|
-
└── my-
|
|
39
|
-
├── package.json #
|
|
38
|
+
└── my-agent/
|
|
39
|
+
├── package.json # agent's own deps
|
|
40
40
|
├── node_modules/
|
|
41
41
|
├── graph.mjs
|
|
42
42
|
└── nodes/
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
The cloud bundle build does the same — `npm install` runs *inside* the
|
|
45
|
+
The cloud bundle build does the same — `npm install` runs *inside* the agent folder, scoped to its own package.json.
|
|
46
46
|
|
|
47
47
|
## Configuration
|
|
48
48
|
|
|
@@ -65,7 +65,7 @@ export default {
|
|
|
65
65
|
};
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
`zibby
|
|
68
|
+
`zibby agent deploy` resolves this file locally and ships the result as `zibby.config.json` inside the deploy bundle, so the cloud runtime sees the same `agent` block, per-node `models`, and other declarative knobs as your local runs. Function values are dropped at deploy time (config is data, not code) — if you need runtime variation in cloud, use [per-agent env vars](../cloud/env-vars).
|
|
69
69
|
|
|
70
70
|
## Source
|
|
71
71
|
|
package/docs/packages/core.md
CHANGED
|
@@ -7,7 +7,7 @@ title: '@zibby/core'
|
|
|
7
7
|
|
|
8
8
|
[](https://www.npmjs.com/package/@zibby/core)
|
|
9
9
|
|
|
10
|
-
The batteries — five built-in agent strategies, the runtime, and a re-export of the `@zibby/agent-workflow` engine. This is what `zibby
|
|
10
|
+
The batteries — five built-in agent strategies, the runtime, and a re-export of the `@zibby/agent-workflow` engine. This is what `zibby agent new` scaffolds agents against.
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
13
|
npm install @zibby/core
|
|
@@ -63,7 +63,7 @@ Functions used by the cloud executor and Studio integration — `ZibbyRuntime`,
|
|
|
63
63
|
|
|
64
64
|
| Goal | Pick |
|
|
65
65
|
|---|---|
|
|
66
|
-
| Build
|
|
66
|
+
| Build an agent with built-in strategies (cursor/claude/codex/gemini/assistant) | `@zibby/core` |
|
|
67
67
|
| Embed the engine in your own app with custom agents only | `@zibby/agent-workflow` |
|
|
68
68
|
| Use the CLI | `@zibby/cli` (transitively pulls both) |
|
|
69
69
|
|