@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.
Files changed (92) hide show
  1. package/dist/browser.d.ts +0 -17
  2. package/dist/browser.js +3 -3
  3. package/dist/code-scan.d.ts +1 -1
  4. package/dist/index.d.ts +0 -1
  5. package/dist/index.js +97 -97
  6. package/dist/jira.d.ts +75 -9
  7. package/dist/jira.js +4 -4
  8. package/dist/package.json +1 -1
  9. package/dist/report.d.ts +51 -276
  10. package/dist/trackers/index.js +12 -12
  11. package/dist/trackers/jira-adapter.js +11 -11
  12. package/package.json +1 -1
  13. package/docs/analysis.md +0 -109
  14. package/docs/apps/agent-ops.md +0 -130
  15. package/docs/apps/auth.md +0 -158
  16. package/docs/apps/deploy.md +0 -207
  17. package/docs/apps/goal-mode.md +0 -175
  18. package/docs/apps/index.md +0 -149
  19. package/docs/apps/managing.md +0 -121
  20. package/docs/cli-reference.md +0 -494
  21. package/docs/cloning-repositories.md +0 -285
  22. package/docs/cloud/bundles.md +0 -92
  23. package/docs/cloud/dedicated-egress.md +0 -140
  24. package/docs/cloud/editing-prompts.md +0 -79
  25. package/docs/cloud/env-vars.md +0 -144
  26. package/docs/cloud/limits.md +0 -81
  27. package/docs/cloud/logs.md +0 -104
  28. package/docs/cloud/triggering.md +0 -128
  29. package/docs/concepts/agents.md +0 -112
  30. package/docs/concepts/designing-agents.md +0 -247
  31. package/docs/concepts/graph.md +0 -83
  32. package/docs/concepts/sessions.md +0 -70
  33. package/docs/concepts/skills.md +0 -86
  34. package/docs/concepts/state.md +0 -106
  35. package/docs/concepts/sub-graphs.md +0 -227
  36. package/docs/custom-workflows.md +0 -358
  37. package/docs/get-started/deploy.md +0 -75
  38. package/docs/get-started/install.md +0 -60
  39. package/docs/get-started/run-locally.md +0 -94
  40. package/docs/get-started/trigger-and-logs.md +0 -90
  41. package/docs/get-started/use-from-agents.md +0 -153
  42. package/docs/get-started/your-first-workflow.md +0 -69
  43. package/docs/getting-started.md +0 -108
  44. package/docs/installation.md +0 -127
  45. package/docs/integrations/github.md +0 -73
  46. package/docs/integrations/gitlab.md +0 -43
  47. package/docs/integrations/jira.md +0 -71
  48. package/docs/integrations/lark.md +0 -41
  49. package/docs/integrations/linear.md +0 -43
  50. package/docs/integrations/notion.md +0 -33
  51. package/docs/integrations/plane.md +0 -46
  52. package/docs/integrations/sentry.md +0 -42
  53. package/docs/integrations/slack.md +0 -33
  54. package/docs/intro.md +0 -86
  55. package/docs/legacy/test-automation.md +0 -111
  56. package/docs/packages/agent-workflow.md +0 -88
  57. package/docs/packages/cli.md +0 -73
  58. package/docs/packages/core.md +0 -72
  59. package/docs/packages/mcp-browser.md +0 -110
  60. package/docs/packages/mcp-cli.md +0 -176
  61. package/docs/packages/memory.md +0 -223
  62. package/docs/packages/skills.md +0 -218
  63. package/docs/packages/ui-memory.md +0 -245
  64. package/docs/recipes/bug-autofix.md +0 -85
  65. package/docs/recipes/github-ai-scout.md +0 -61
  66. package/docs/recipes/index.md +0 -68
  67. package/docs/recipes/pipeline-supervisor.md +0 -57
  68. package/docs/recipes/sentry-triage.md +0 -93
  69. package/docs/recipes/test.md +0 -190
  70. package/docs/reviewing-results.md +0 -114
  71. package/docs/running-tests.md +0 -134
  72. package/docs/self-host/backup-restore.md +0 -53
  73. package/docs/self-host/custom-sidecars.md +0 -136
  74. package/docs/self-host/index.md +0 -75
  75. package/docs/self-host/storage.md +0 -50
  76. package/docs/self-host/troubleshooting.md +0 -48
  77. package/docs/self-host/upgrade.md +0 -81
  78. package/docs/skills/browser.md +0 -97
  79. package/docs/skills/chat-memory.md +0 -122
  80. package/docs/skills/core-tools.md +0 -80
  81. package/docs/skills/function-skill.md +0 -93
  82. package/docs/skills/github.md +0 -91
  83. package/docs/skills/index.md +0 -46
  84. package/docs/skills/jira.md +0 -99
  85. package/docs/skills/lark.md +0 -85
  86. package/docs/skills/memory.md +0 -92
  87. package/docs/skills/sentry.md +0 -80
  88. package/docs/skills/slack.md +0 -89
  89. package/docs/tests/memory.md +0 -131
  90. package/docs/triggering-workflows.md +0 -552
  91. package/docs/workflow-artifact-layout-evaluation.md +0 -119
  92. package/docs/workflow.md +0 -558
@@ -1,60 +0,0 @@
1
- ---
2
- sidebar_position: 1
3
- title: 1. Install
4
- pagination_prev: intro
5
- pagination_next: get-started/your-first-workflow
6
- ---
7
-
8
- # Install the CLI
9
-
10
- You build **Agents** with Zibby — deployed automations. The CLI command is `zibby agent`.
11
-
12
- ```bash
13
- npm install -g @zibby/cli
14
- ```
15
-
16
- Verify:
17
-
18
- ```bash
19
- zibby --version
20
- ```
21
-
22
- You should see something like `zibby v0.4.x`.
23
-
24
- ## No global install? Use npx
25
-
26
- Every example below works with `npx @zibby/cli` instead of `zibby`:
27
-
28
- ```bash
29
- npx @zibby/cli agent new my-agent
30
- ```
31
-
32
- The first call downloads the package; subsequent calls use the cached copy.
33
-
34
- ## Log in
35
-
36
- Cloud features (deploy, trigger, logs) need authentication:
37
-
38
- ```bash
39
- zibby login
40
- ```
41
-
42
- This opens your browser and writes a session token to `~/.zibby/config.json`. Logged in for 30 days.
43
-
44
- For CI/CD, set `ZIBBY_API_KEY` in the environment instead — the CLI prefers that over the saved session.
45
-
46
- ## Pick an agent runtime
47
-
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
-
50
- | Agent | How to install | Auth |
51
- |---|---|---|
52
- | **Cursor** | Install [Cursor](https://cursor.com), or `npm i -g cursor-agent` | `cursor-agent login` (or `CURSOR_API_KEY`) |
53
- | **Claude Code** | `npm i -g @anthropic-ai/claude-agent-sdk` | `ANTHROPIC_API_KEY` |
54
- | **Codex** | `npm i -g @openai/codex` | `OPENAI_API_KEY` |
55
- | **Gemini** | `npm i -g @google/gemini-cli` | `GOOGLE_API_KEY` |
56
- | **Assistant** | None — uses OpenAI Assistants API | `OPENAI_API_KEY` |
57
-
58
- You only need one. The cloud runtime supports all five out of the box.
59
-
60
- → Next: [Your first agent](./your-first-workflow)
@@ -1,94 +0,0 @@
1
- ---
2
- sidebar_position: 3
3
- title: 3. Run it locally
4
- pagination_prev: get-started/your-first-workflow
5
- pagination_next: get-started/deploy
6
- ---
7
-
8
- # Run an agent locally
9
-
10
- ```bash
11
- zibby agent run my-agent
12
- ```
13
-
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>/`:
15
-
16
- - `result.json` — the final structured output (Zod-validated)
17
- - `raw_stream_output.txt` — every byte the agent emitted
18
- - `events.json` — JSONL execution log: which node ran when, what it received, what it returned, retries
19
- - `.session-info.json` — session metadata
20
-
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
-
23
- ## Pass input
24
-
25
- Most agents take input. Edit `graph.mjs` to define an input schema and reference `state.input`:
26
-
27
- ```js
28
- graph.addNode('plan', {
29
- prompt: ({ input }) => `Triage this ticket: ${input.ticket}`,
30
- outputSchema: z.object({ tasks: z.array(z.string()) }),
31
- agent: 'claude',
32
- });
33
- ```
34
-
35
- Then pass input via `--input`:
36
-
37
- ```bash
38
- zibby agent run my-agent --input '{"ticket":"BUG-123"}'
39
- ```
40
-
41
- Or `--param key=value` (repeatable, dot-notation supported):
42
-
43
- ```bash
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
- ```
47
-
48
- Or `--input-file payload.json` for larger payloads.
49
-
50
- Precedence: `--param` > `--input` > `--input-file`. Same as `trigger`.
51
-
52
- ## Iterating
53
-
54
- Each run is a fresh process — re-edit `graph.mjs` or any node file and re-run. There's no daemon to restart; tool errors and crashes don't leave a server hanging on port 3848.
55
-
56
- If you want auto-rerun on file change, run it under `nodemon`:
57
-
58
- ```bash
59
- npx nodemon --ext mjs,js --exec "zibby agent run my-agent -p ticket=BUG-123"
60
- ```
61
-
62
- Or add it to your agent's `package.json`:
63
-
64
- ```json
65
- {
66
- "scripts": {
67
- "dev": "nodemon --ext mjs,js --exec \"zibby agent run my-agent\""
68
- }
69
- }
70
- ```
71
-
72
- Then `npm run dev`.
73
-
74
- ## Inspect a run
75
-
76
- After a run finishes, the CLI prints the session ID. Open the session folder to inspect every step:
77
-
78
- ```bash
79
- ls .zibby/output/sessions/<sessionId>/
80
- cat .zibby/output/sessions/<sessionId>/result.json | jq
81
- ```
82
-
83
- ## Studio (long-lived server, optional)
84
-
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
-
87
- ```bash
88
- zibby agent start my-agent # long-lived server on :3848 (Studio talks to this)
89
- zibby studio # launch the desktop app
90
- ```
91
-
92
- For CLI-only iteration, stick with `zibby agent run`.
93
-
94
- → Next: [Deploy to cloud](./deploy)
@@ -1,90 +0,0 @@
1
- ---
2
- sidebar_position: 5
3
- title: 5. Trigger & tail logs
4
- pagination_prev: get-started/deploy
5
- ---
6
-
7
- # Run a deployed agent and watch logs
8
-
9
- ## Trigger
10
-
11
- ```bash
12
- zibby agent trigger 2b1ea07f-3ede-4bfd-a51d-431f0bab008e
13
- ```
14
-
15
- The CLI returns immediately with a job ID:
16
-
17
- ```
18
- ✔ Workflow triggered successfully
19
-
20
- Job Details:
21
- Job ID: ee333411-22e6-4733-b790-d480af3f662e
22
- Status: running
23
- Version: 3
24
- Triggered: 02/05/2026, 10:23:13
25
-
26
- Monitor execution:
27
- zibby agent logs 2b1ea07f-...
28
- zibby agent logs 2b1ea07f-... -t
29
- ```
30
-
31
- Pass input the same way as locally:
32
-
33
- ```bash
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
- ```
38
-
39
- If you omit the UUID, the CLI shows an interactive picker over your deployed agents.
40
-
41
- ## Tail logs (Heroku-style)
42
-
43
- ```bash
44
- zibby agent logs 2b1ea07f-3ede-4bfd-a51d-431f0bab008e -t
45
- ```
46
-
47
- `-t` follows live. Without `-t` it dumps the last execution and exits.
48
-
49
- ```
50
- Streaming logs for workflow 2b1ea07f-3ede-4bfd-a51d-431f0bab008e...
51
- Press Ctrl+C to stop.
52
-
53
- 2026-05-02 23:30:51.345 zibby v0.4.x
54
- ────────────────────────────────────────────────────────────
55
- Workflow: my-agent
56
- Job: ee333411-...
57
- Project: 6b60049d-...
58
- Agent: cursor (model: auto)
59
- ────────────────────────────────────────────────────────────
60
- [setup] Bundle extracted (3.2s)
61
- [setup] Loaded MyPipelineWorkflow
62
- [setup] Registered 5 agent strategies (...)
63
-
64
- ┌ example
65
- │ ◆ Model: auto | key: ***bc97
66
- │ ...
67
- └ done 19.4s
68
- [done] my-agent completed in 19.4s
69
- ```
70
-
71
- The stream covers the full execution end-to-end — agent reasoning, tool calls, schema validation, completion summary.
72
-
73
- ## Multiple executions
74
-
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
-
77
- To exit after the current run, just Ctrl+C — there's no "exit on completion" mode (yet).
78
-
79
- ## Triggering from anywhere
80
-
81
- The CLI is the easiest way, but agents expose an HTTP API for programmatic triggering — see [Cloud → Triggering programmatically](../cloud/triggering).
82
-
83
- ## You're done
84
-
85
- You've now scaffolded, run locally, deployed, triggered, and tailed an agent. The rest of the docs go deeper:
86
-
87
- - [Concepts](../concepts/graph) — how the graph engine works
88
- - [CLI Reference](../cli-reference) — every command
89
- - [Cloud](../cloud/triggering) — HTTP triggers, log archives, bundle internals
90
- - [Packages](../packages/agent-workflow) — package-level docs
@@ -1,153 +0,0 @@
1
- ---
2
- sidebar_position: 6
3
- title: 6. Use from your AI agent
4
- pagination_prev: get-started/trigger-and-logs
5
- ---
6
-
7
- # Use Zibby from Claude Code, Cursor, Codex, or Gemini
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 agents, trigger runs, tail logs — all without leaving your editor.
10
-
11
- ```
12
- You: Deploy the browser-test template to my Playhouse project, then run it.
13
- Agent: → zibby_scaffold_agent
14
- → zibby_deploy_agent
15
- → zibby_trigger_agent
16
- → "Done. Job a23e… completed in 47s, 0 failures."
17
- ```
18
-
19
- The MCP server runs **locally** as a subprocess of your agent — no Zibby-hosted endpoint, no credentials shared with us, no proxy in the middle. Your existing `~/.zibby/config.json` session is reused if you've already run `zibby login`.
20
-
21
- ## Install
22
-
23
- Pick your agent. All flavors run the same npm package via `npx -y` — no global install.
24
-
25
- ### Claude Code
26
-
27
- Add to `~/.claude/settings.json`:
28
-
29
- ```json
30
- {
31
- "mcpServers": {
32
- "zibby": {
33
- "command": "npx",
34
- "args": ["-y", "@zibby/mcp-cli"]
35
- }
36
- }
37
- }
38
- ```
39
-
40
- ### Cursor
41
-
42
- Add to `~/.cursor/mcp.json`:
43
-
44
- ```json
45
- {
46
- "mcpServers": {
47
- "zibby": {
48
- "command": "npx",
49
- "args": ["-y", "@zibby/mcp-cli"]
50
- }
51
- }
52
- }
53
- ```
54
-
55
- ### OpenAI Codex CLI
56
-
57
- Add to `~/.codex/config.toml`:
58
-
59
- ```toml
60
- [mcp_servers.zibby]
61
- command = "npx"
62
- args = ["-y", "@zibby/mcp-cli"]
63
- ```
64
-
65
- ### Gemini CLI
66
-
67
- Add to `~/.gemini/settings.json`:
68
-
69
- ```json
70
- {
71
- "mcpServers": {
72
- "zibby": {
73
- "command": "npx",
74
- "args": ["-y", "@zibby/mcp-cli"]
75
- }
76
- }
77
- }
78
- ```
79
-
80
- ### Windows note
81
-
82
- If your agent on Windows can't find `npx`, wrap with `cmd /c`:
83
-
84
- ```json
85
- {
86
- "mcpServers": {
87
- "zibby": {
88
- "command": "cmd",
89
- "args": ["/c", "npx", "-y", "@zibby/mcp-cli"]
90
- }
91
- }
92
- }
93
- ```
94
-
95
- ## First-time login
96
-
97
- If you haven't run `zibby login` yet in a terminal, just tell the agent:
98
-
99
- ```
100
- You: Log in to Zibby.
101
- Agent: → zibby_login
102
- (browser opens to the Zibby login page)
103
- → "Logged in as you@yourcompany.com (3 projects cached)."
104
- ```
105
-
106
- Login state lives in `~/.zibby/config.json` (mode `0600`) — the same file the CLI writes. Subsequent agent sessions reuse it.
107
-
108
- ## What the agent can do
109
-
110
- | Read-only | Write |
111
- |---|---|
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
-
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
-
121
- See the [`@zibby/mcp-cli` package reference](../packages/mcp-cli) for the full tool list and security model.
122
-
123
- ## Example session
124
-
125
- ```
126
- You: What templates are available?
127
-
128
- Agent: → zibby_list_templates
129
- "Three official templates:
130
- - browser-test-automation: Playwright preflight + live execution + script gen
131
- - code-analysis: Jira ticket → analyze → generate code → emit tests
132
- - generate-test-cases: code diff → prioritized AI-runnable test specs"
133
-
134
- You: Scaffold generate-test-cases into a new agent called "release-tests" in my Playhouse project.
135
-
136
- Agent: → zibby_list_projects (resolves "Playhouse" → projectId)
137
- → zibby_scaffold_agent name=release-tests template=generate-test-cases
138
- → zibby_validate_agent name=release-tests
139
- "Scaffolded and validated. Ready to deploy."
140
-
141
- You: Deploy it.
142
-
143
- Agent: → zibby_deploy_agent name=release-tests projectId=…
144
- "Deployed v1 — UUID 33039db5-2f32-4094-9841-317bc56a88c9."
145
-
146
- You: Run it against this PR diff: ‹pastes diff›
147
-
148
- Agent: → zibby_trigger_agent uuid=33039db5… input={diff: "...", changedFiles: [...]}
149
- → zibby_agent_logs jobId=c62e97a4… lines=100
150
- "Run completed in 1m 23s. Generated 7 test specs (4 Critical, 2 High, 1 Medium)."
151
- ```
152
-
153
- → Full tool reference: [`@zibby/mcp-cli`](../packages/mcp-cli)
@@ -1,69 +0,0 @@
1
- ---
2
- sidebar_position: 2
3
- title: 2. Your first agent
4
- pagination_prev: get-started/install
5
- pagination_next: get-started/run-locally
6
- ---
7
-
8
- # Scaffold your first agent
9
-
10
- An **Agent** is a deployed automation. Scaffold one with the CLI with the `zibby agent` CLI:
11
-
12
- ```bash
13
- zibby agent new my-agent
14
- # zibby agent new my-agent # alias — identical
15
- ```
16
-
17
- This creates:
18
-
19
- ```
20
- .zibby/workflows/my-agent/
21
- ├── graph.mjs # the workflow definition (entry point)
22
- ├── nodes/
23
- │ └── example.mjs # a sample node
24
- ├── package.json # agent's own deps (each agent is a self-contained npm project)
25
- └── workflow.json # manifest (workflow name, entry class)
26
- ```
27
-
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
-
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
-
32
- ## What's in graph.mjs
33
-
34
- ```js
35
- import { z } from '@zibby/core';
36
- import { WorkflowAgent, WorkflowGraph } from '@zibby/agent-workflow';
37
- import { exampleNode } from './nodes/example.mjs';
38
-
39
- export class MyPipelineWorkflow extends WorkflowAgent {
40
- buildGraph() {
41
- const graph = new WorkflowGraph();
42
-
43
- graph.addNode('example', {
44
- prompt: exampleNode.prompt,
45
- outputSchema: z.object({
46
- summary: z.string(),
47
- status: z.enum(['ok', 'warn', 'error']),
48
- }),
49
- agent: 'cursor', // per-node agent override
50
- });
51
-
52
- graph.setEntryPoint('example');
53
- return graph;
54
- }
55
- }
56
- ```
57
-
58
- The shape is:
59
-
60
- - `graph.addNode(name, config)` — register a node. `prompt` becomes the agent's input; `outputSchema` (Zod) defines the contract for what comes back.
61
- - `graph.addEdge(from, to)` — wire two nodes together.
62
- - `graph.addConditionalEdges(from, fn)` — branch on state.
63
- - `graph.setEntryPoint(name)` — first node to run.
64
-
65
- ## Picking the agent
66
-
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
-
69
- → Next: [Run it locally](./run-locally)
@@ -1,108 +0,0 @@
1
- ---
2
- sidebar_position: 2
3
- title: Getting Started
4
- ---
5
-
6
- # Getting Started
7
-
8
- Get up and running with Zibby in under 5 minutes.
9
-
10
- ## Prerequisites
11
-
12
- - Node.js 18 or later
13
- - [Cursor](https://cursor.com) IDE installed (for `--agent cursor`), **or** an Anthropic API key (for `--agent claude`), **or** OpenAI API key + Codex CLI (for `--agent codex`)
14
-
15
- ## Option A: Zero Setup (npx)
16
-
17
- No install needed — run directly:
18
-
19
- ```bash
20
- echo "Go to example.com and verify the page title says Example Domain" > test.txt
21
- npx @zibby/cli run test.txt --agent cursor
22
- ```
23
-
24
- ## Option B: Global Install
25
-
26
- ```bash
27
- npm install -g @zibby/cli
28
- ```
29
-
30
- ### 1. Create a test spec
31
-
32
- Create a plain-text file with your test instructions:
33
-
34
- ```text title="test-specs/login.txt"
35
- 1. Navigate to https://myapp.com/login
36
- 2. Enter email: test@example.com
37
- 3. Enter password: TestPass123
38
- 4. Click the Sign In button
39
- 5. Verify the dashboard page loads
40
- 6. Verify the user's name appears in the header
41
- ```
42
-
43
- ### 2. Run it
44
-
45
- ```bash
46
- zibby test test-specs/login.txt --agent cursor
47
- ```
48
-
49
- You'll see:
50
- - A browser window open
51
- - The AI agent navigate and interact with your app
52
- - A generated Playwright script saved to `tests/`
53
-
54
- ### 3. Run the generated test
55
-
56
- ```bash
57
- npx playwright test tests/login.spec.js
58
- ```
59
-
60
- ## Customizing Your Setup (Optional)
61
-
62
- If you want to customize the workflow, config, or nodes:
63
-
64
- ```bash
65
- zibby init --agent cursor
66
- ```
67
-
68
- This scaffolds:
69
-
70
- ```
71
- .zibby.config.js # Project configuration (ESM)
72
- .zibby/
73
- ├── graph.js # Workflow definition (customizable)
74
- ├── nodes/ # Node implementations
75
- │ ├── execute-live.js
76
- │ ├── generate-script.js
77
- │ └── preflight.js
78
- └── result-handler.js # Post-execution hooks
79
- ```
80
-
81
- Without `zibby init`, the CLI uses the built-in default workflow automatically.
82
-
83
- ## Environment Variables
84
-
85
- | Variable | When needed |
86
- |---|---|
87
- | `CURSOR_API_KEY` | CI/CD with `--agent cursor` (locally uses Cursor IDE credentials) |
88
- | `ANTHROPIC_API_KEY` | Using `--agent claude` |
89
- | `OPENAI_API_KEY` | Using `--agent codex` |
90
- | `ZIBBY_API_KEY` | Cloud sync (`--sync` flag) |
91
-
92
- For local development, add these to a `.env` file in your project root.
93
-
94
- ## Cloud Sync (Optional)
95
-
96
- To upload results to the [Zibby dashboard](https://zibby.app):
97
-
98
- 1. Create an account at [zibby.app](https://zibby.app)
99
- 2. Get your API key from **Project Settings**
100
- 3. Add to `.env`: `ZIBBY_API_KEY=zby_your_key_here`
101
- 4. Login: `zibby login`
102
- 5. Run with sync: `zibby test test-specs/login.txt --sync`
103
-
104
- ## Next Steps
105
-
106
- - [Installation](/installation) — detailed setup and configuration
107
- - [Running Tests](/running-tests) — all run modes and options
108
- - [CLI Reference](/cli-reference) — every command and flag
@@ -1,127 +0,0 @@
1
- ---
2
- sidebar_position: 3
3
- title: Installation
4
- ---
5
-
6
- # Installation
7
-
8
- ## Install the CLI
9
-
10
- ```bash
11
- npm install -g @zibby/cli
12
- ```
13
-
14
- Verify:
15
-
16
- ```bash
17
- zibby --version
18
- ```
19
-
20
- Or use without installing:
21
-
22
- ```bash
23
- npx @zibby/cli run test.txt --agent cursor
24
- ```
25
-
26
- ## Project Setup (Optional)
27
-
28
- `zibby test` works without any project setup — it uses a built-in workflow. To customize:
29
-
30
- ```bash
31
- cd your-project
32
- zibby init --agent cursor
33
- ```
34
-
35
- **Options:**
36
-
37
- | Flag | Description |
38
- |---|---|
39
- | `--agent <type>` | `cursor` or `claude` |
40
- | `--cloud-sync` | Enable cloud sync and configure API |
41
- | `--headless` | Run browser in headless mode |
42
- | `--headed` | Run browser in headed mode (visible) |
43
- | `--skip-install` | Skip `npm install` |
44
- | `-f, --force` | Overwrite existing config |
45
-
46
- This creates:
47
-
48
- ```
49
- .zibby.config.js # Project configuration
50
- .zibby/
51
- ├── graph.js # Workflow graph (entry point → nodes → END)
52
- ├── nodes/
53
- │ ├── preflight.js # Extract title + assertions from spec
54
- │ ├── execute-live.js # AI drives browser
55
- │ └── generate-script.js # Generate Playwright script
56
- └── result-handler.js # Save artifacts after execution
57
- ```
58
-
59
- ## Configuration
60
-
61
- `.zibby.config.js` in your project root (ESM format):
62
-
63
- ```javascript
64
- export default {
65
- agent: {
66
- cursor: {
67
- model: 'auto',
68
- },
69
- // OR:
70
- // claude: {
71
- // model: 'auto',
72
- // maxTokens: 4096,
73
- // },
74
- },
75
-
76
- paths: {
77
- specs: 'test-specs',
78
- generated: 'tests',
79
- output: '.zibby/output',
80
- },
81
-
82
- video: 'on',
83
- viewport: { width: 1280, height: 720 },
84
- playwrightArtifacts: true,
85
- cloudSync: false,
86
- };
87
- ```
88
-
89
- ## Environment Setup
90
-
91
- Copy the generated `.env.example` to `.env` and add your keys:
92
-
93
- ```bash
94
- cp .env.example .env
95
- ```
96
-
97
- Then edit `.env` with your values:
98
-
99
- ```bash
100
- # For Cursor agent in CI/CD
101
- CURSOR_API_KEY=your-cursor-api-key
102
-
103
- # For Claude agent
104
- ANTHROPIC_API_KEY=sk-ant-...
105
-
106
- # For cloud sync (optional)
107
- ZIBBY_API_KEY=zby_your_api_key_here
108
- ```
109
-
110
- ## Playwright Setup
111
-
112
- Zibby uses Playwright for browser automation. If you don't have it:
113
-
114
- ```bash
115
- zibby setup-playwright
116
- ```
117
-
118
- This configures the Playwright MCP server for Zibby.
119
-
120
- ## Verify Setup
121
-
122
- ```bash
123
- echo "Go to example.com and verify the page title" > test.txt
124
- zibby test test.txt --agent cursor
125
- ```
126
-
127
- You should see a browser open, the AI navigate to example.com, and a Playwright script generated in `tests/`.