Saphan StudioDocs
Reference/Commands

saphan board

Exports the board: the workspace's recorded account of its work, with each stream's state, decision history and last commit.

Exports the board: the workspace's recorded account of its work, with each stream's state, decision history and last commit.

saphan board

saphan board export

Writes the recorded history of the workspace's streams as a report: md for a readable weekly summary, csv for spreadsheet-ready rows (one file of gate events, one of stream summaries), pdf for a plain paginated archival document, or html for a single self-contained styled file that opens, mails and prints anywhere. It reads only the persisted record. Cost columns read "not yet attributed" rather than zero, because per-stream cost is not yet attributed.

saphan board export --format html --out ~/reports/week-42.html
saphan board export --format csv --out ~/reports/week-42
saphan board export --format md|csv|pdf|html --out <path> [--force] (or --stdout)
flagtypedefaultwhat it does
--csvstringWith --format csv, write only one of the two files: events or streams. By default both are written.
--forceboolfalseAllow --out to replace an existing file; without it an existing file is refused.
--formatstringThe report format: md, csv, pdf or html. Required.
--full-pathsboolfalseFor html only, show absolute file paths; by default html shows them relative to the workspace. ⚠ md, csv and pdf always show paths as recorded, which can reveal your disk layout.
--outstringWhere to write the report. For csv without --csv this is a base name that gets .events.csv and .streams.csv appended. Required unless --stdout is used.
--stdoutboolfalseWrite the report to standard output for piping instead of to a file; messages go to standard error. pdf refuses this when output is a terminal.

Global options apply to every command — see Every command.

On this page