Skip to content

Commit 03f09ad

Browse files
committed
Couple fixes
1 parent ec8011a commit 03f09ad

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
@@ -563,7 +563,7 @@ viam locations api-key create --location-id=<location-id>
563563
| Command option | Description | Positional arguments |
564564
| -------------- | ----------- | -------------------- |
565565
| `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 |
566-
| `api-key` | Work with an api-key for your location | `create` |
566+
| `api-key` | Work with an API key for your location | `create` |
567567
| `--help` | Return help | - |
568568

569569
##### Positional arguments: `api-key`
@@ -1190,6 +1190,9 @@ viam profiles list
11901190

11911191
# Remove a profile
11921192
viam profiles remove --profile-name=mycompany
1193+
1194+
# Example of using a profile to see a list of machines available to that profile
1195+
viam --profile=mycompany machines list
11931196
```
11941197

11951198
See [create an organization API key](#create-an-organization-api-key) for more information.
@@ -1250,7 +1253,7 @@ Examples:
12501253
viam machines list
12511254

12521255
# get machine status
1253-
viam machines status --machine=123 --location=myLoc
1256+
viam machines status --machine=123
12541257

12551258
# create an api key for a machine
12561259
viam machines api-key create --machine-id=123 --name=MyKey
@@ -1297,7 +1300,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
12971300
| Command option | Description | Positional arguments |
12981301
| -------------- | ----------- | -------------------- |
12991302
| `list` | List all machines that the authenticated session has access to, filtered by organization and location. | - |
1300-
| `api-key` | Work with an api-key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
1303+
| `api-key` | Work with an API key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
13011304
| `status` | Retrieve machine status for a specified machine | - |
13021305
| `logs` | Retrieve logs for a specified machine | - |
13031306
| `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell`, `restart`, `tunnel`, `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. |
@@ -1332,7 +1335,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
13321335
| -------- | ----------- | ------------------- | --------- |
13331336
| `--organization` | Organization name or ID that the machine belongs to | `list`, `status`, `logs`, `part` | Optional |
13341337
| `--location` | Location name or ID that the machine belongs to or to list machines in | `list`, `status`, `logs`, `part` | Optional |
1335-
| `--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** |
1338+
| `--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 |
13361339
| `--errors` | Boolean, return only errors (default: false) | `logs` | Optional |
13371340
| `--levels` | Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. | `logs` | Optional |
13381341
| `--part` | Part name or ID for which the command is being issued | `logs`, `part` | Optional |

0 commit comments

Comments
 (0)