Saphan StudioDocs
Reference/Commands

saphan grammar

Prints the document formats compiled into this binary, so an agent or operator on a remote machine can read them without a source checkout, and manages the list of declared document keys.

Prints the document formats compiled into this binary, so an agent or operator on a remote machine can read them without a source checkout, and manages the list of declared document keys. Run it with a subcommand.

saphan grammar

saphan grammar declare

Adds a document key to the declared-keys file: a key the document formats name but no part of the engine reads yet. After that, saphan doc check warns that the key's value reaches no reader instead of refusing the document; no parser starts reading the key. It writes ~/.saphan/grammar-declarations.md (or the file named by SAPHAN_GRAMMAR_DECLARATIONS), not the record; it asks for no owner code, so anyone who can write that file can add a row. ⚠ Every saphan command loads this file first and refuses to run while it is unreadable or invalid. Used when developing Saphan Studio; not needed to operate an installation.

saphan grammar declare <family> <key>
flagtypedefaultwhat it does
--canonstringWhere the document formats name this key, as file:line; required.
--classstringHow the value would be read once something reads it: atomic, prose, vocabulary or manifest; required.
--lands-instringThe planned engine change that will give the key a reader and remove this declaration; required.
--sincestringThe declaration date as YYYY-MM-DD; defaults to today (UTC).

saphan grammar declared

Lists the declared keys from the declared-keys file: keys the document formats name that no part of the engine reads yet, with where each is cited and the change expected to give it a reader. Used when developing Saphan Studio; not needed to operate an installation.

saphan grammar declared

saphan grammar owner-block

Prints the format of the owner block — the fenced block an agent uses to put a gate decision, a question or an alert in front of the owner — with a glossary of its element kinds and a one-line example of each.

saphan grammar owner-block

Global options apply to every command — see Every command.

On this page