Skip to content

Commit eeb9cf9

Browse files
authored
Fix machines list CLI info (#4531)
1 parent 84a2168 commit eeb9cf9

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/dev/tools/cli.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -767,8 +767,8 @@ viam machines part cp --part=<part id> <file name> machine:/path/to/file
767767
Examples:
768768

769769
```sh {class="command-line" data-prompt="$"}
770-
# list all machines you have access to
771-
viam machines list
770+
# list all machines in an organization, in all locations
771+
viam machines list --all --organization=12345
772772

773773
# get machine status
774774
viam machines status --machine=123
@@ -820,7 +820,7 @@ viam machines part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exi
820820
<!-- prettier-ignore -->
821821
| Command option | Description | Positional arguments |
822822
| -------------- | ----------- | -------------------- |
823-
| `list` | List all machines that the authenticated session has access to, filtered by organization and location. | - |
823+
| `list` | List all machines that the authenticated session has access to in a specified organzation or location. Defaults to first organization and location alphabetically. | - |
824824
| `api-key` | Work with an API key for your machine. | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
825825
| `status` | Retrieve machine status for a specified machine. | - |
826826
| `logs` | Retrieve logs for a specified machine. | - |
@@ -859,6 +859,7 @@ viam machines part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exi
859859
| `--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** |
860860
| `--location` | ID of the location that the machine belongs to or to list machines in. | `list`, `status`, `logs`, `part` | Optional |
861861
| `--organization` | ID of the organization that the machine belongs to or to list machines in. | `list`, `status`, `logs`, `part` | Optional |
862+
| `--all` | List all machines in the organization. Overrides `--location` flag. Default: `false` | `list` | Optional |
862863
| `--errors` | Boolean, return only errors (default: false). | `logs` | Optional |
863864
| `--levels` | Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. | `logs` | Optional |
864865
| `--tail` | Tail (stream) logs, boolean(default false). | `part logs` | Optional |

0 commit comments

Comments
 (0)