Step-by-Step Guide

step_guide

Turn a recording's event log into a numbered how-to: a ringed screenshot and caption per step, marker headings; Markdown and/or one HTML file. Never includes typed text.

producewritesdestructivesince v0.46.0

00:00PARAMETERS

Name	Type	Description
`input`	`string`	Recording path (uses its .events.jsonl).
`sessionId`	`string`	Or a stopped session's id.
`title`	`string`	Guide title. at most 200 characters
`format`	`"md" \| "html" \| "both"`	md + images/, self-contained html, or both (default).
`ocr`	`boolean`	OCR shots for captions and secret boxes (default true; needs Windows OCR).
`outputDir`	`string`	Guide folder (default: new in SCREENCAST_HOME/edits).
`overwrite`	`boolean`	Replace a guide already in outputDir.

00:05A MINIMAL CALL

step_guide {}

The required arguments only, with placeholder values. Everything else takes its default.

00:10WHAT COMES BACK

Structured content (structuredContent), alongside a text summary:

Field	Type
`outputDir` always	`string`