Skip to content

Commit 00341ae

Browse files
Fix error in CLI machine API key creation doc (#4392)
Co-authored-by: Jessamy Taylor <[email protected]>
1 parent e108ff4 commit 00341ae

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/dev/tools/cli.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -669,14 +669,14 @@ 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>
672+
viam machines status --machine=<machine id>
673+
viam machines logs --machine=<machine id> [...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>
676676
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>
677+
viam machines part status --machine=<machine id>
678+
viam machines part run --machine=<machine id> [--stream] --data <method>
679+
viam machines part shell --machine=<machine id> --part=<part id>
680680
viam machines part restart --machine=<machine id> --part=<part id>
681681
viam machines part cp --part=<part id> <file name> machine:/path/to/file
682682
```
@@ -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 --name=MyKey
695695

696696
# stream logs from a machine
697697
viam machines logs --machine=123
@@ -773,9 +773,9 @@ 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, `--organization` 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 |
778-
| `--org` | ID of the organization that the machine belongs to or to list machines in. | `list`, `status`, `logs`, `part` | Optional |
778+
| `--organization` | 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 |
780780
| `--levels` | Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. | `logs` | Optional |
781781
| `--tail` | Tail (stream) logs, boolean(default false). | `part logs` | Optional |

0 commit comments

Comments
 (0)