Saphan StudioDocs
Reference/Commands

saphan capture

Signs and records one spark (a short captured idea) or a session transcript, keeping the exact bytes and indexing them in the record.

Signs and records one spark (a short captured idea) or a session transcript, keeping the exact bytes and indexing them in the record. It signs with this workspace's signing key, so it refuses until saphan actor init has created one. When evidence storage is configured, the bytes are also stored durably and the entry is marked acknowledged; if that store write fails the entry stays unacknowledged so you can retry. Capturing bytes already recorded returns the existing entry.

saphan capture --kind transcript --file session.log --stream payments-refactor
saphan capture
flagtypedefaultwhat it does
--actorstringThe name recorded as capturing; defaults to SAPHAN_ACTOR, then the identity in your configuration. It is recorded, not authenticated.
--filestringThe file whose exact bytes are captured, unchanged; - reads standard input. Required.
--kindstringWhat is captured: spark or transcript. Required.
--refstringAn optional free-text note on where this came from. Never put a secret here.
--streamstringThe stream, gate or other context that prompted this capture, if any.
--supersedesint640The id of an earlier spark this capture revises.
--tostringThe role that should pick this up next; only advisor is accepted.

saphan capture archive

Archives a spark so it no longer shows as active, without deleting its signed capture. Anyone who can run commands in the workspace can archive any spark.

saphan capture archive
flagtypedefaultwhat it does
--idint640The id of the spark to archive. Required.

saphan capture catch

Records a spark's words directly in the record, without signing it and without storing a separate copy of the bytes; this is what the console's quick-capture uses.

saphan capture catch
flagtypedefaultwhat it does
--actorstringThe name recorded as catching the spark; defaults to SAPHAN_ACTOR, then the identity in your configuration. It is recorded, not authenticated.
--streamstringThe screen or stream the spark was caught on, if any.
--supersedesint640The id of an earlier spark this one revises.
--textstringThe spark's words. Required.

saphan capture list

Lists recorded captures in id order.

saphan capture list
flagtypedefaultwhat it does
--limitint0Show at most this many entries; 0 means no limit.
--streamstringShow only captures prompted by this stream.

saphan capture route

Sends an active spark to the next role that should handle it.

saphan capture route
flagtypedefaultwhat it does
--idint640The id of the spark to route. Required.
--tostringThe role to send it to; only advisor is accepted. Required.

saphan capture show

Shows one recorded capture by its id.

saphan capture show <id>

Global options apply to every command — see Every command.

On this page