Output and Exports

Output and Exports

When you stop a recording, stepshot writes the report into the session folder (~/Pictures/stepshot/session-<timestamp>/ by default):

File	What it is
report.html	Self-contained HTML — images embedded as base64, one file you can send.
report.md	Markdown version (images referenced as files).
report.pdf	Paginated PDF, one section per step, screenshots embedded.
report.docx	Word-compatible document with embedded screenshots.
step-001.png, …	The individual step screenshots.

By default all four report formats are produced from the same steps, so they describe the same session in the same order. You can choose which formats get written via [export] formats in the config — see Configuration.

Notes

• HTML is the shareable one — it embeds every screenshot, so a single report.html is fully portable.
• PDF and DOCX are pure-Rust — no external tools (no LaTeX, no LibreOffice) and no bundled browser engine are involved.
• The HTML/Markdown are written incrementally during recording; the PDF and DOCX are produced on stop. If a PDF or DOCX export fails for some reason, the HTML and Markdown are still written (the failure is logged and skipped).
• Empty sessions (0 steps) write no report.

Languages

The report (and the UI and notifications) is localized and auto-detected from LANGUAGE / LC_ALL / LC_MESSAGES / LANG, defaulting to English. English, German, French, Spanish and Italian ship today (French, Spanish and Italian are machine-assisted translations — native review is welcome); adding a language is a small, self-contained contribution (one file under src/i18n/).