Commands

Commands

Global Flags

Flag	Description
--config <path>	Path to config file (default: auto-detect stepshots.config.json).
--verbose, -v	Enable verbose/debug logging.
--version	Print version.
--help	Print help.

stepshots init

Generate a sample stepshots.config.json in the current directory.

Flag	Description
--force	Overwrite existing config file.

stepshots record

Record tutorials into .stepshot bundles.

Flag	Default	Description
--tutorial, -t	All	Record only specific tutorials (by key). Repeatable.
--output, -o	output/	Output directory for .stepshot files.
--dry-run	false	Show what would be recorded without launching a browser.

stepshots preview

Open a tutorial in a visible browser window for testing.

stepshots preview <tutorial-key>

stepshots upload

Upload .stepshot bundles to the Stepshots API.

stepshots upload <files...>

Flag	Default	Description
--title	—	Override the demo title.
--server	https://stepshots.com	Server URL. Also: STEPSHOTS_SERVER env var.
--token	—	API token. Also: STEPSHOTS_TOKEN env var. Required.

stepshots serve

Start a local HTTP server for browser extension integration.

Flag	Default	Description
--port, -p	8124	Port to listen on.
--output, -o	output/	Output directory for recorded bundles.