hauju/Stepshots Record
Record and verify interactive product demos with Stepshots CLI
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| command | What to run: record (capture bundles) or verify (drift check, writes no bundles) | no | record |
| config | Path to stepshots.config.json | no | stepshots.config.json |
| tutorials | Comma-separated tutorial keys to record or verify (default: all) | no | — |
| output | Output directory for .stepshot bundles (record) or failure screenshots and the report (verify) | no | output |
| fail-on | Verify only: fail the step on 'fail' (broken steps) or 'warn' (also annotation drift) | no | fail |
| upload | Upload bundles after recording | no | false |
| token | Stepshots API token (required if upload is true) | no | — |
| server | Stepshots server URL | no | https://stepshots.com |
| demo-id | Replace an existing demo instead of creating a new one | no | — |
| title | Override the demo title on upload | no | — |
| version | Stepshots CLI version (git ref) to install | no | main |
Outputs
| name | description |
|---|---|
| bundles | Newline-separated list of recorded .stepshot files (record command only) |
| report | Path to the verify JSON report (verify command only) |