Saphan StudioDocs
Reference/Commands

saphan round

Records facts about a round — one pass of work on a stream, normally carried out by an agent run — when part of that round was done by hand.

Records facts about a round — one pass of work on a stream, normally carried out by an agent run — when part of that round was done by hand.

saphan round declare

Declares a round that was done by hand, with no agent run: it writes the registry entry that saphan absorb and saphan merge rely on and files a round document recording the worktree's current commit. The stream must already have an order on record; otherwise the declaration is refused and names saphan channel put --kind master-order as the fix. A round that an agent run has already returned cannot be declared, and the worktree must sit in the workspace's worktrees layout (<repo>/wt-<stream>).

saphan round declare --stream <s> --round <N> --self-authored --by <seat> --worktree <path> --base <ref> [--branch <name>]
flagtypedefaultwhat it does
--basestringThe branch or commit the round was cut from and lands on. Required.
--branchstringThe round's branch; defaults to the branch checked out in --worktree.
--bystringThe seat that did the work, recorded as its author; a declared name that is not verified. Required.
--landed-by-handstringThe commit of a merge already made by hand, when declaring after the fact; it must resolve in the worktree and is recorded.
--move-worktreeboolfalseConfirm that the stream's registered worktree is deliberately moving to --worktree; without it, a different worktree is refused.
--roundint0The round number. Required and positive.
--self-authoredboolfalseDeclare a round that no agent run carried out. Required.
--streamstringThe stream. Required.
--worktreestringThe round's worktree. Required.

saphan round retip

Files the status document in the stream's worktree as a new status for the round, after a commit made by hand moved the branch past the commit the record holds. It is refused unless the commit the document names is the branch's current tip and a descendant of the recorded commit, so the recorded tip can only move forward. The status document in the worktree is rewritten with a stamp naming the filer and the commit it supersedes. It does not check that the document describes the new commits; the rehearsal (saphan dry-run round retip) lists their subjects so you can.

saphan round retip --stream <s> --by <seat>
flagtypedefaultwhat it does
--bystringThe seat filing the new status, stamped into it; a declared name that is not verified. Required.
--streamstringThe stream.

Global options apply to every command — see Every command.

On this page