Computer CLI reference
Inspect placement targets, change their labels and policy, or open one in Atoi.
On this page
Use this page to inspect every public atoi computer command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.
atoi computerInspect placement targets, change their labels and policy, or open one in Atoi.
| Command | What it does |
|---|---|
atoi computer list | List Cloud and connected Computers with availability and policy. |
atoi computer get | Read one Computer by id or friendly name. |
atoi computer rename | Change the friendly name shown for a Computer. |
atoi computer set-policy | Choose when Atoi may place work on a Computer. |
atoi computer open | Open the selected Computer in Atoi. |
#computer list
List Cloud and connected Computers with availability and policy.
atoi computer list
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run computer list
atoi computer list --json
#computer get
Read one Computer by id or friendly name.
atoi computer get <computer-id-or-name> [--computer <computer-id>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--computer | string | Select a Computer by exact id instead of a positional target. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run computer get
atoi computer get cmp_5r8x --json
#computer rename
Change the friendly name shown for a Computer.
atoi computer rename <computer-id-or-name> --name <name>
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--computer | string | Select a Computer by exact id instead of a positional target. | ||
--name required | string | Set the new friendly name. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run computer rename
atoi computer rename cmp_5r8x --name "Studio Mac" --json
#computer set-policy
Choose when Atoi may place work on a Computer.
atoi computer set-policy <computer-id-or-name> --policy <ask|always|never>
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--computer | string | Select a Computer by exact id instead of a positional target. | ||
--policy required | string | ask, always, never | Set the placement policy. | |
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run computer set-policy
atoi computer set-policy cmp_5r8x --policy ask --json
#computer open
Open the selected Computer in Atoi.
atoi computer open <computer-id-or-name>
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--computer | string | Select a Computer by exact id instead of a positional target. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run computer open
atoi computer open cmp_5r8x --json
Was this useful?