Saphan StudioDocs
Reference/Commands

saphan memory

Carries an agent role's memory notes into the bridge (the shared coordination repository) and reads them back.

Carries an agent role's memory notes into the bridge (the shared coordination repository) and reads them back. carry is the only subcommand that writes; recall, show and search only read, never follow a symlink, refuse --json, and never print an entry marked private or one that declares no visibility class.

saphan memory

saphan memory carry

Stages the memory entries a role wrote on this machine into the bridge, or with --push sends each one to the bound gateway. An entry with no provenance line (when, in which run and by which role it was measured) is refused by name, a private entry stays on this machine, and an entry the bridge already holds with different content is reported, never overwritten; refused or differing entries make the command exit non-zero. If the bridge cannot be reached, or the write-set does not allow a path, the outcome is unreachable, nothing is written and the command exits non-zero; a second run over the same entries writes nothing. It never deletes or edits an entry in place. Without --push nothing is committed or pushed: saphan bridge commit and saphan bridge push do that. saphan dry-run memory carry shows the same plan and refusals without writing.

saphan memory carry
flagtypedefaultwhat it does
--fromstringThe memory directory the role writes into; only the Markdown files directly inside it are read. Required.
--pushboolfalseSend each entry to the gateway this workspace is bound to, as its own bridge commit, instead of staging it in --repo (which is then only read); an unbound workspace is refused rather than falling back to staging, and a gateway refusal is printed as given.
--repostringThe bridge repository to stage the entries into. Required; never inferred from the current directory.
--rolestringWhose memory this is: master, executor, review, design, scribe or advisor. It decides the destination directory. Required.
--scopestringbridgeThe tree the destination paths are checked against: bridge (the default), bridge-registry, worktree, or a repository named in the workspace inventory.
--streamstringThe stream (unit of work) name substituted into the role's allowed paths, for write-sets that use one.
--write-setstringThe write-set document listing which bridge paths this role may write. Required. ⚠ This build checks paths against it but does not verify the document's signature.

saphan memory recall

Prints the role's memory index and the shared memory index from a bridge working tree, rebuilt from the entry files on every call; a directory without memory/ is refused. If the two together exceed --budget-bytes, nothing is printed and the refusal names what did not fit: the output is never cut to size. Entries that fail the memory format are named without their content, and make the command exit non-zero.

saphan memory recall
flagtypedefaultwhat it does
--budget-bytesint0The most bytes this recall may print; must be a positive number. Required; there is no default.
--repostringThe bridge working tree to read. Required.
--rolestringWhose memory to recall beside the shared entries: master, executor, review, design, scribe or advisor. Required.

Lists every memory entry in which all the given terms appear (case-insensitive substring match), naming the fields that matched; at least one term is required. It is a plain text match: nothing is ranked, and withheld or unreadable entries are never searched, only counted.

saphan memory search <term>...
flagtypedefaultwhat it does
--repostringThe bridge working tree to read. Required.
--rolestringSearch only this role's directory beside the shared entries; by default every role's directory is searched.

saphan memory show

Prints one memory entry verbatim, found by its file name or its declared name. A name found in two places is refused as ambiguous, naming both paths; a private or unreadable entry is refused and its content is not printed.

saphan memory show <name>
flagtypedefaultwhat it does
--repostringThe bridge working tree to read. Required.
--rolestringLook only in this role's directory beside the shared entries; by default every role's directory is searched.

Global options apply to every command — see Every command.

On this page