create-canary 0.1.0 → 0.2.1
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 +43 -10
- package/dist/cli.js +9072 -28841
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,26 +1,59 @@
|
|
|
1
1
|
# create-canary
|
|
2
2
|
|
|
3
|
-
The setup wizard for [
|
|
4
|
-
drives real browsers, records QA sessions (Playwright trace, video, network HAR, console), and
|
|
5
|
-
renders self-contained verification reports.
|
|
3
|
+
> The guided setup wizard for [Canary](https://github.com/usecanary/canary) — an AI-agent QA toolkit
|
|
4
|
+
> that drives real browsers, records QA sessions (Playwright trace, video, network HAR, console), and
|
|
5
|
+
> renders self-contained verification reports.
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/create-canary)
|
|
8
|
+
[](https://github.com/usecanary/canary)
|
|
9
|
+
|
|
10
|
+
One command to get Canary, its browser runtime, and the agent integration set up — no flags to
|
|
11
|
+
remember. Every step just shells out to the same published commands you could run by hand, so there's
|
|
12
|
+
no magic and nothing bespoke to uninstall.
|
|
6
13
|
|
|
7
14
|
## Use
|
|
8
15
|
|
|
9
16
|
```bash
|
|
10
17
|
npm create canary
|
|
11
|
-
# or:
|
|
18
|
+
# or: npm init canary · pnpm create canary · yarn create canary
|
|
12
19
|
```
|
|
13
20
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
21
|
+
You'll get a checklist (space toggles, enter confirms). Recommended items are pre-selected:
|
|
22
|
+
|
|
23
|
+
| Step | Default | What it runs |
|
|
24
|
+
| --- | --- | --- |
|
|
25
|
+
| Install the `canary` command globally | ✓ | `npm i -g @usecanary/cli` |
|
|
26
|
+
| Install the browser runtime (Chromium) | ✓ | `canary install` |
|
|
27
|
+
| Install the agent skills (any tool) | ✓ | `npx skills add usecanary/canary` |
|
|
28
|
+
| Install the Claude Code plugin (slash commands) | ✓ | `claude plugin marketplace add …` + `plugin install …` |
|
|
29
|
+
| Also install `canary-browser` globally | — | `npm i -g @usecanary/browser` |
|
|
30
|
+
| Also install the `canary-viewer` viewer globally | — | `npm i -g @usecanary/ui` |
|
|
31
|
+
|
|
32
|
+
Installing the CLIs globally puts `canary`, `canary-browser`, and `canary-viewer` on your `PATH` so
|
|
33
|
+
day-to-day use drops the `npx` prefix. If the Claude Code CLI isn't found, the wizard prints the
|
|
34
|
+
in-app `/plugin …` commands to run instead.
|
|
35
|
+
|
|
36
|
+
### Non-interactive
|
|
37
|
+
|
|
38
|
+
In a pipe or CI (no TTY), the wizard prints the exact commands to run instead of prompting — safe to
|
|
39
|
+
inspect before executing.
|
|
17
40
|
|
|
18
41
|
## After setup
|
|
19
42
|
|
|
20
43
|
```bash
|
|
21
|
-
canary
|
|
22
|
-
canary session
|
|
23
|
-
|
|
44
|
+
canary session start --name "checkout" # start a recorded session (prints an id)
|
|
45
|
+
canary run ./step.js --session <id> --step "open"
|
|
46
|
+
canary session end <id> # -> ~/.canary/sessions/<id>/report.html
|
|
47
|
+
canary-viewer # browse recorded sessions
|
|
24
48
|
```
|
|
25
49
|
|
|
50
|
+
Using a coding agent? Try `/canary:verify` (plan QA for your changes) or `/canary:session` (record a
|
|
51
|
+
flow) in Claude Code / Cursor / Codex. See `examples/` in the repo for runnable demos.
|
|
52
|
+
|
|
53
|
+
## Related packages
|
|
54
|
+
|
|
55
|
+
- [`@usecanary/cli`](https://www.npmjs.com/package/@usecanary/cli) — the `canary` session orchestrator.
|
|
56
|
+
- [`@usecanary/browser`](https://www.npmjs.com/package/@usecanary/browser) — one-off automation engine.
|
|
57
|
+
- [`@usecanary/ui`](https://www.npmjs.com/package/@usecanary/ui) — the `canary-viewer` session browser.
|
|
58
|
+
|
|
26
59
|
MIT · [source](https://github.com/usecanary/canary)
|