Installation — Stepshots Docs

Install the CLI

The Stepshots CLI is a single binary built with Rust. You can install it from crates.io or from source.

From crates.io

bash

cargo install stepshots-cli

If you don't have Rust installed, get it from rustup.rs.

From source

bash

git clone https://github.com/hauju/stepshots.git
cd stepshots
cargo install --path crates/cli

Verify

bash

stepshots --version

Prerequisites

The CLI uses headless Chrome to record demos, so you need Google Chrome or Chromium installed on your system.

The CLI auto-detects Chrome at its default install location. If Chrome is installed elsewhere, set the CHROME_PATH environment variable:

bash

export CHROME_PATH=/path/to/chrome

Upgrade

Update to the latest version at any time:

bash

stepshots upgrade

Or reinstall via Cargo:

bash

cargo install stepshots-cli --force

Browser Extension

For manual recording (instead of config-based CLI recording), install the Stepshots Chrome extension:

Clone the repository and build the extension:

bash

git clone https://github.com/hauju/stepshots.git
cd stepshots/extension
bun install
bun run build

Open chrome://extensions in Chrome
Enable Developer mode
Click Load unpacked and select the extension/ folder

Tip

The CLI is best for stable, scripted recordings. The browser extension is best for quick captures and UI flows you want to record directly from the live product.

Next Steps

Quickstart — Record your first demo in 5 minutes
Configuration — Customize your stepshots.config.json