setup
verbmutateMake the root, install the pinned tools and set what the host needs; --dry-run shows the plan and changes 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.
| Property | Value |
|---|---|
kind | action |
effect | mutate |
idempotent | true |
audience | both |
tier | public |
dryRun | true |
check | false |
reachChannels | local |
reachReadOnly | false |
reachNeedsTty | false |
reachRunsAs | caller |
reachConfirmation | none |
Options
| Option | Meaning | Properties |
|---|---|---|
--home | The root of the workspace for this run (else $ERGONEX_HOME, else $HOME/workspaces). | type=value, required=false, standard=false, humanOnly=false, valueName=DIR |
--git-include | Add one marked [include] of the generated git.auto.conf to your global Git configuration, after showing the change and, where a person can be asked, asking. | type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false |
--json | Write one JSON document and nothing else for a person. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--quiet | Show only how it ended. | type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--verbose | Show every step as it happens. | type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--color | Use colour where the terminal shows it (--no-color turns it off). | type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true |
--non-interactive | Never ask a question: where one is needed, fail and say so. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--dry-run | Show what would change and change nothing. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
Examples
ergonex setup --dry-run # Show the plan and change nothing.
ergonex setup # Carry the plan out.
ergonex setup --git-include # Also add the generated Git configuration to yours, after showing the change.Physical: what it is drawn as
ergonex setup
cli-command. Make the root, install the pinned tools and set what the host needs; --dry-run shows the plan and changes nothing.
| Property | Value |
|---|---|
usage | ergonex setup |
words | setup |
tier | public |
Not drawn
- mcp: its reach policy does not name the mcp channel
- rest: its reach policy does not name the rest channel