Saphan StudioDocs
Reference/Commands

saphan return

Brings a stream's results home from the run that worked on it — its status file into the stream's local channel, its committed branch into this workspace's repository, and for a review run the reviewe

Brings a stream's results home from the run that worked on it — its status file into the stream's local channel, its committed branch into this workspace's repository, and for a review run the reviewer's verdict and evidence into the reviewed stream's worktree, with content-addressed copies kept in the engine's state — and verifies each against its source by SHA-256 or commit. Use it after a run on a remote machine finishes, and to deliver every review, local or remote, before the review can be recorded.

Every attempt, including refused ones, is written to the record with both branch tips, what arrived and what is still owed. A refusal names its cause — a missing file, a digest mismatch, a partial return — and nothing is written for a half that did not verify. ⛔ A returned branch that is not a fast-forward of your local branch is refused: your local history is never rewound, and the local branch is left where it was.

saphan return <stream>
flagtypedefaultwhat it does
--historyboolfalsePrint this stream's recorded return attempts and exit, without contacting any machine.
--roundstringThe run id to return from, instead of the stream's latest run; host, workdir and other facts are read from that run's record.

saphan return waive

Writes off one finished run whose return can never land, so the gates and stop2 stop waiting for it: a review run replaced by a later review of the same stream with a landed return, or an executor run followed by the coordinating agent's own commits on the stream's branch. It records one row naming the run, what replaced it, you and your reason. This is an owner act; rehearse it with saphan dry-run return waive.

saphan return waive <stream> --round <run-id> --reason <text>
flagtypedefaultwhat it does
--actorstringThe person deciding; defaults to SAPHAN_ACTOR, then the configured identity.
--proposed-reasonstringA reason the coordinating agent proposes, shown on your terminal when --reason is empty; press Enter to make it yours, or type your own instead.
--reasonstringYour reason for writing the run off, in your own words (required).
--roundstringThe id of the run to write off (required).

Global options apply to every command — see Every command.

On this page