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.
report.odt	LibreOffice Writer document with embedded screenshots.
report.rtf	Rich Text (Word/WordPad), screenshots embedded.
report.txt	Plain text — numbered steps, images referenced by filename.
step-001.png, …	The individual step screenshots.

By default all 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.
• Every format is pure-Rust — no external tools (no LaTeX, no LibreOffice, no Word) and no bundled browser engine are involved. Even the ODT container is built by a small hand-rolled ZIP writer.
• The HTML/Markdown are written incrementally during recording; the other formats are produced on stop. If one export fails, the rest 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/).