Skip to content

Commit dfee792

Browse files
committed
Couple fixes
1 parent 14569fe commit dfee792

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/dev/tools/cli.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ viam locations api-key create --location-id=<location-id>
558558
| Command option | Description | Positional arguments |
559559
| -------------- | ----------- | -------------------- |
560560
| `list` | List all locations (name and id) that the authenticated session has access to, grouped by organization | **organization id** : (_optional_) return results for specified organization only |
561-
| `api-key` | Work with an api-key for your location | `create` |
561+
| `api-key` | Work with an API key for your location | `create` |
562562
| `--help` | Return help | - |
563563

564564
##### Positional arguments: `api-key`
@@ -1184,6 +1184,9 @@ viam profiles list
11841184

11851185
# Remove a profile
11861186
viam profiles remove --profile-name=mycompany
1187+
1188+
# Example of using a profile to see a list of machines available to that profile
1189+
viam --profile=mycompany machines list
11871190
```
11881191

11891192
See [create an organization API key](#create-an-organization-api-key) for more information.
@@ -1244,7 +1247,7 @@ Examples:
12441247
viam machines list
12451248

12461249
# get machine status
1247-
viam machines status --machine=123 --location=myLoc
1250+
viam machines status --machine=123
12481251

12491252
# create an api key for a machine
12501253
viam machines api-key create --machine-id=123 --name=MyKey
@@ -1288,7 +1291,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
12881291
| Command option | Description | Positional arguments |
12891292
| -------------- | ----------- | -------------------- |
12901293
| `list` | List all machines that the authenticated session has access to, filtered by organization and location. | - |
1291-
| `api-key` | Work with an api-key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
1294+
| `api-key` | Work with an API key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
12921295
| `status` | Retrieve machine status for a specified machine | - |
12931296
| `logs` | Retrieve logs for a specified machine | - |
12941297
| `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell`, `restart`, `cp` (see [positional arguments: part](#positional-arguments-part)). To use the `part shell` and `part cp` commands, you must add the [ViamShellDanger fragment](https://app.viam.com/fragment/b511adfa-80ab-4a70-9bd5-fbb14696b17e/json) to your machine. |
@@ -1322,7 +1325,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
13221325
| -------- | ----------- | ------------------- | --------- |
13231326
| `--organization` | Organization name or ID that the machine belongs to | `list`, `status`, `logs`, `part` | Optional |
13241327
| `--location` | Location name or ID that the machine belongs to or to list machines in | `list`, `status`, `logs`, `part` | Optional |
1325-
| `--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` | **Required** |
1328+
| `--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 |
13261329
| `--errors` | Boolean, return only errors (default: false) | `logs` | Optional |
13271330
| `--levels` | Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. | `logs` | Optional |
13281331
| `--part` | Part name or ID for which the command is being issued | `logs`, `part` | Optional |

0 commit comments

Comments
 (0)