Skip to content

Commit ea6eb41

Browse files
Fix error in CLI machine API key creation doc
Fixes #4390
1 parent 1e0c976 commit ea6eb41

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/dev/tools/cli.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -669,15 +669,15 @@ This includes:
669669

670670
```sh {class="command-line" data-prompt="$"}
671671
viam machines list
672-
viam machines status --organization=<org id> --location=<location id> --machine=<machine id>
673-
viam machines logs --organization=<org id> --location=<location id> --machine=<machine id> [...named args]
674-
viam machines api-key create --machine=<machine id> [...named args]
675-
viam machines part list --machine=<machine-id>
676-
viam machines part logs --machine=<machine id> --part=<part id> [...named args]
677-
viam machines part status --organization=<org id> --location=<location id> --machine=<machine id>
678-
viam machines part run --organization=<org id> --location=<location id> --machine=<machine id> [--stream] --data <meth>
679-
viam machines part shell --organization=<org id> --location=<location id> --machine=<machine id> --part=<part id>
680-
viam machines part restart --machine=<machine id> --part=<part id>
672+
viam machines status --organization=<org id> --location=<location id> --machine=<machine id or name>
673+
viam machines logs --organization=<org id> --location=<location id> --machine=<machine id or name> [...named args]
674+
viam machines api-key create --machine-id=<machine id> --org-id=<org-id> --name=<key-name>
675+
viam machines part list --machine=<machine id or name>
676+
viam machines part logs --machine=<machine id or name> --part=<part id> [...named args]
677+
viam machines part status --organization=<org id> --location=<location id> --machine=<machine id or name>
678+
viam machines part run --organization=<org id> --location=<location id> --machine=<machine id or name> [--stream] --data <meth>
679+
viam machines part shell --organization=<org id> --location=<location id> --machine=<machine id or name> --part=<part id>
680+
viam machines part restart --machine=<machine id or name> --part=<part id>
681681
viam machines part cp --part=<part id> <file name> machine:/path/to/file
682682
```
683683

@@ -691,7 +691,7 @@ viam machines list
691691
viam machines status --machine=123
692692

693693
# create an api key for a machine
694-
viam machines api-key create --machine=123 --name=MyKey
694+
viam machines api-key create --machine-id=123 --org-id=456 --name=MyKey
695695

696696
# stream logs from a machine
697697
viam machines logs --machine=123
@@ -773,7 +773,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
773773
| Argument | Description | Applicable commands | Required? |
774774
| -------- | ----------- | ------------------- | --------- |
775775
| `--part` | Part ID for which the command is being issued. | `part` | **Required** |
776-
| `--machine` | Machine ID for which the command is being issued. If machine name is used instead of ID, `--org` and `--location` are required. | `status`, `logs` | **Required** |
776+
| `--machine` | Machine ID or name for which the command is being issued. If machine name is used instead of ID, `--org` and `--location` are required. | `status`, `logs` | **Required** |
777777
| `--location` | ID of the location that the machine belongs to or to list machines in. | `list`, `status`, `logs`, `part` | Optional |
778778
| `--org` | ID of the organization that the machine belongs to or to list machines in. | `list`, `status`, `logs`, `part` | Optional |
779779
| `--errors` | Boolean, return only errors (default: false). | `logs` | Optional |
@@ -787,7 +787,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
787787
| `--output` | The path to the output file to store logs in. | `logs` | Optional |
788788
| `--stream` | If specified, the interval in which to stream the specified data, for example, 100ms or 1s. | `part run` | Optional |
789789
| `--data` | Command data for the command being request to run (see [data argument](#using-the---stream-and---data-arguments)). | `part run` | **Required** |
790-
| `--machine-id` | The ID of the machine to create an API key for. | `api-key` | **Required** |
790+
| `--machine-id` | The ID or name of the machine to create an API key for. | `api-key` | **Required** |
791791
| `--name` | The optional name of the API key. | `api-key` | Optional |
792792
| `--recursive`, `-r` | Recursively copy files. Default: `false`. | `part cp` | Optional |
793793
| `--preserve`, `-p` | Preserve modification times and file mode bits from the source files. Default: `false`. | `part cp` | Optional |

0 commit comments

Comments
 (0)