stagewright
v0.3.0
Published
Stagewright CLI: record narrated product walkthroughs on your machine or in any CI, report them to Stagewright, and run the MCP server for coding agents.
Maintainers
Readme
stagewright
Record narrated product walkthroughs from YAML, on your machine or in any CI. The same file is the video and an end-to-end check: when a PR breaks the flow, the run fails with the video and the screen it failed on.
npx stagewright init # .walkthroughs/example.yaml and stagewright.config.ts
npx stagewright doctor # checks Chromium and ffmpeg; --install adds Chromium
npx stagewright record .walkthroughs/example.yamlNo account needed. The video lands in .stagewright/out/<id>/final.mp4, with captions, chapters, a poster and a Playwright trace.
# .walkthroughs/invite.yaml
id: invite-a-teammate
title: Invite a teammate
steps:
- id: open
narration: Team settings list everyone in your workspace.
actions:
- goto: /settings/team
expect:
- visible: 'role=heading[name="Team"]'
- id: invite
narration: Type their email and send the invite.
actions:
- fill: { target: 'role=textbox[name="Email"]', value: [email protected] }
- click: 'role=button[name="Invite"]'
expect:
- visible: text=Invite sentYour app
baseUrlinstagewright.config.tspoints at it: localhost, a dev instance or a preview deploy.stagewright authsaves a signed-in session (sign in by hand once; SSO and MFA work).- The Stagewright plugin gives Claude Code and Codex skills, commands and the MCP server:
/plugin marketplace add stagewright-ai/plugins, then/plugin install stagewright@stagewright(Codex:codex plugin marketplace add stagewright-ai/plugins). For other agents,stagewright skills addandstagewright mcp(claude mcp add stagewright -- npx stagewright mcp). stagewright import playwright tests/x.spec.tsconverts an existing test.
With Stagewright
stagewright login, then stagewright run reports runs (visual diffs against the approved baseline, approvals, publishing to your help center), and stagewright ci does the same in GitHub Actions, GitLab or Buildkite with a PR comment and check.
Needs Node.js 22.18 or newer and ffmpeg. stagewright help lists every command; questions to [email protected].
