IF Commons GitHub

plan

verbread

Show the plan the manifest and what is on disk make, and change nothing.

Program ergonex-administrator. Origin ergonex.

Governance: the action

What the verb is and may do, as governance says it. Each annotation is expressed by the surfaces or says why it is not.

PropertyValue
kindreport
effectread
idempotenttrue
audienceboth
tierpublic
dryRunfalse
checkfalse
reachChannelslocal, mcp
reachReadOnlytrue
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Options

OptionMeaningProperties
--homeThe root of the workspace for this run (else $ERGONEX_HOME, else $HOME/workspaces).type=value, required=false, standard=false, humanOnly=false, valueName=DIR
--fetchFetch each repository's remote first, so that ahead and behind are against the remote as it is now (the only use of the network).type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--jsonWrite one JSON document and nothing else for a person.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--sarifWrite the findings as SARIF 2.1.0 and nothing else.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--quietShow only how it ended.type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false
--verboseShow every step as it happens.type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false
--colorUse colour where the terminal shows it (--no-color turns it off).type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true
--non-interactiveNever ask a question: where one is needed, fail and say so.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

ergonex plan  # Show what apply would do, and change nothing.

Physical: what it is drawn as

ergonex plan

cli-command. Show the plan the manifest and what is on disk make, and change nothing.

PropertyValue
usageergonex plan
wordsplan
tierpublic

ergonex_plan

mcp-tool. Show the plan the manifest and what is on disk make, and change nothing. (report, effect read, safe to repeat.)

PropertyValue
titleergonex plan
toolNameergonex_plan
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputshome, fetch
tierpublic

Not drawn

  • rest: its reach policy does not name the rest channel

Titles, headings, exports, tables, columns and requirements. Esc closes.