Protocol method · cmd

cmd.apply

Run a batch of commands as one atomic, reviewable transaction; dryRun returns the diff.

Params

Param	Required	Description
`commands`	yes	Calls, run in order as one atomic transaction.
`doc`		Document to edit: a path (`levels/outpost.scene`, or just `outpost`), asset ID or `@path#id`. Default: the one document holding every entity the commands address, else the project's main scene.
`session`	yes	Session handle from `session.begin`.
`why`		Why, in a sentence; shown in review next to the change. Required for agent sessions (except dry runs).
`dryRun`		Validate and return the diff without applying anything.
`base`		Revision the batch was planned against; fails if later edits touched the same fields.
`idempotencyKey`		Retrying with the same key returns the first result instead of applying twice.
`branch`		Branch session (`br_…` from `branch.open`) to apply in instead of the live documents: nobody sees it until `branch.submit` merges it. Claims do not block edits inside your own branch.