create-canary

The guided setup wizard for Canary — an AI-agent QA toolkit that drives real browsers, records QA sessions (Playwright trace, video, network HAR, console), and renders self-contained verification reports.

One command to get Canary and its browser runtime set up — no flags to remember. Every step just shells out to the same published commands you could run by hand, so there's no magic and nothing bespoke to uninstall. Agent integration (skills, Claude Code plugin) is deliberately left to you: after setup the wizard prints the exact commands to run.

Use

npm create canary
# or:  npm init canary  ·  pnpm create canary  ·  yarn create canary

You'll get a checklist (space toggles, enter confirms). Recommended items are pre-selected:

| Step | Default | What it runs | | --- | --- | --- | | Install the canary command globally | ✓ | npm i -g @usecanary/cli | | Install the browser runtime (Chromium) | ✓ | canary install | | Also install canary-browser globally | — | npm i -g @usecanary/browser | | Also install the canary-viewer viewer globally | — | npm i -g @usecanary/ui |

Installing the CLIs globally puts canary, canary-browser, and canary-viewer on your PATH so day-to-day use drops the npx prefix. The wizard never installs the plugins itself — once setup completes it prints the commands (Claude Code /plugin …, Cursor / Codex marketplace) so each agent's own mechanism does the work.

Non-interactive

In a pipe or CI (no TTY), the wizard prints the exact commands to run instead of prompting — safe to inspect before executing.

After setup

Add the agent integration yourself (one-time):

# Claude Code: /plugin marketplace add wizenheimer/canary  then  /plugin install canary@canary-marketplace

Then record a session:

canary session start --name "checkout"   # start a recorded session (prints an id)
canary run ./step.js --session <id> --step "open"
canary session end <id>                  # -> ~/.canary/sessions/<id>/report.html
canary-viewer                            # browse recorded sessions

Using a coding agent? Try /canary:verify (plan QA for your changes) or /canary:session (record a flow) in Claude Code / Cursor / Codex. See examples/ in the repo for runnable demos.

Related packages

• @usecanary/cli — the canary session orchestrator.
• @usecanary/browser — one-off automation engine.
• @usecanary/ui — the canary-viewer session browser.

MIT · source