create-canary 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/LICENSE +23 -0
  2. package/README.md +26 -0
  3. package/dist/cli.js +36518 -0
  4. package/package.json +50 -0
package/LICENSE ADDED
@@ -0,0 +1,23 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Canary contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
23
+ Portions of this project are derived from MIT-licensed work by Sawyer Hood.
package/README.md ADDED
@@ -0,0 +1,26 @@
1
+ # create-canary
2
+
3
+ The setup wizard for [canary](https://github.com/usecanary/canary) — an AI-agent QA toolkit that
4
+ drives real browsers, records QA sessions (Playwright trace, video, network HAR, console), and
5
+ renders self-contained verification reports.
6
+
7
+ ## Use
8
+
9
+ ```bash
10
+ npm create canary
11
+ # or: npm init canary · pnpm create canary · yarn create canary
12
+ ```
13
+
14
+ The wizard installs the canary runtime into `~/.canary`, sets up the orchestrator CLI
15
+ ([`@usecanary/cli`](https://www.npmjs.com/package/@usecanary/cli)), and optionally wires up the
16
+ agent skill so a coding agent can record sessions for you.
17
+
18
+ ## After setup
19
+
20
+ ```bash
21
+ canary init # one-shot setup (runtime + agent skill)
22
+ canary session start --name "checkout"
23
+ npx @usecanary/ui # browse recorded sessions
24
+ ```
25
+
26
+ MIT · [source](https://github.com/usecanary/canary)