Skip to content

Commit 45d36b0

Browse files
committed
Unify flags for machines part
1 parent 03f09ad commit 45d36b0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/dev/tools/cli.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The CLI lets you:
2626
For example, this CLI command moves a servo to the 75 degree position:
2727

2828
```sh {class="command-line" data-prompt="$"}
29-
viam machines part run --machine 82c608a-1be9-46a5 --organization "Artoo's Org" \
29+
viam machines part run --machine 82c608a-1be9-46a5 --org "Artoo's Org" \
3030
--location myLoc --part "mymachine-main" --data '{"name": "myServo", "angle_deg":75}' \
3131
viam.component.servo.v1.ServoService.MoveRequest
3232
```
@@ -1235,15 +1235,15 @@ This includes:
12351235

12361236
```sh {class="command-line" data-prompt="$"}
12371237
viam machines list
1238-
viam machines status --organization=<org name> --location=<location name> --machine=<machine id>
1239-
viam machines logs --organization=<org name> --location=<location name> --machine=<machine id> [...named args]
1240-
viam machines api-key create --machine-id=<machine-id> [...named args]
1238+
viam machines status --org=<org name> --location=<location name> --machine=<machine id>
1239+
viam machines logs --org=<org name> --location=<location name> --machine=<machine id> [...named args]
1240+
viam machines api-key create --machine=<machine-id> [...named args]
12411241
viam machines part logs --machine=<machine> --part=<part> [...named args]
1242-
viam machines part status --organization=<org name> --location=<location name> --machine=<machine id>
1243-
viam machines part run --organization=<org name> --location=<location name> --machine=<machine id> [--stream] --data <meth>
1244-
viam machines part shell --organization=<org name> --location=<location name> --machine=<machine id> --part=<part id>
1242+
viam machines part status --org=<org name> --location=<location name> --machine=<machine id>
1243+
viam machines part run --org=<org name> --location=<location name> --machine=<machine id> [--stream] --data <meth>
1244+
viam machines part shell --org=<org name> --location=<location name> --machine=<machine id> --part=<part id>
12451245
viam machines part restart --machine=<machine id> --part=<part id>
1246-
viam machines part cp --organization=<org name> --location=<location name> --machine=<machine id> --part=<part name> <file name> machine:/path/to/file
1246+
viam machines part cp --org=<org name> --location=<location name> --machine=<machine id> --part=<part name> <file name> machine:/path/to/file
12471247
```
12481248

12491249
Examples:
@@ -1256,7 +1256,7 @@ viam machines list
12561256
viam machines status --machine=123
12571257

12581258
# create an api key for a machine
1259-
viam machines api-key create --machine-id=123 --name=MyKey
1259+
viam machines api-key create --machine=123 --name=MyKey
12601260

12611261
# stream logs from a machine
12621262
viam machines logs --machine=123
@@ -1333,9 +1333,9 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
13331333
<!-- prettier-ignore -->
13341334
| Argument | Description | Applicable commands | Required? |
13351335
| -------- | ----------- | ------------------- | --------- |
1336-
| `--organization` | Organization name or ID that the machine belongs to | `list`, `status`, `logs`, `part` | Optional |
1336+
| `--org` | Organization name or ID that the machine belongs to | `list`, `status`, `logs`, `part` | Optional |
13371337
| `--location` | Location name or ID that the machine belongs to or to list machines in | `list`, `status`, `logs`, `part` | Optional |
1338-
| `--machine` | Machine name or ID for which the command is being issued. If machine name is used instead of ID, `--organization` and `--location` are required. | `status`, `logs`, `part` | Optional |
1338+
| `--machine` | Machine name or ID for which the command is being issued. If machine name is used instead of ID, `--org` and `--location` are required. | `status`, `logs`, `part` | Optional |
13391339
| `--errors` | Boolean, return only errors (default: false) | `logs` | Optional |
13401340
| `--levels` | Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. | `logs` | Optional |
13411341
| `--part` | Part name or ID for which the command is being issued | `logs`, `part` | Optional |

0 commit comments

Comments
 (0)