Skip to content

Fix machines list CLI info #4531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 11, 2025
Merged

Fix machines list CLI info #4531

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae72e55
Fix machines list CLI info
JessamyT Aug 4, 2025
7ccde76
Update docs/dev/tools/cli.md
JessamyT Aug 7, 2025
366830d
Update docs/dev/tools/cli.md
npentrel Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/dev/tools/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -769,8 +769,8 @@ viam machines part cp --part=<part id> <file name> machine:/path/to/file
Examples:

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

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