Ara
Download

Search or run a command

Jump to a section or open an Ara link.

CLI

ara do

Run one command as a transaction: ara do property.set -p entity=name:Crate -p path=Light.intensity -p value=500 --why "Dimmer crate light"

Usage

ara do [OPTIONS] [COMMAND]

Arguments

[COMMAND]Command name (entity.create; list them with ara schema). Without one, --args is a whole batch: {commands: [{cmd, args, as}], why, doc}

Options

--doc <DOC>Document to edit (default: the one holding the entities the arguments name, else the project's main scene). outpost is enough
--root <ROOT>Project root (default: the nearest ancestor with ara.project.json)
--args <ARGS>Arguments: a JSON object, @file.json, or - for stdin. Quotes are optional ({entity: e_8b21, value: [1, 0, 0, 1]}), so shells that strip them (PowerShell) are fine
--jsonPrint results as JSON
--author <AUTHOR>Who protocol commands are attributed to: human or agent:<name> (default: ARA_AUTHOR, else the agent running this CLI, else human)
-p, --param <PARAMS>One argument: key=value. Values are JSON ([0,1,0], true) or text; a list may skip quotes (entities=[e_1,e_2]); a.b=1 nests. Repeatable
--as <SYMBOL>Symbolic ID for the record the command creates ($crate)
--why <WHY>Why, in a sentence, shown in review (required for agents)
--dry-runShow the diff without applying
-h, --helpPrint help