Skip to content

Commit ec8011a

Browse files
committed
Fix order on page
1 parent 4e00e67 commit ec8011a

File tree

1 file changed

+53
-53
lines changed

1 file changed

+53
-53
lines changed

docs/dev/tools/cli.md

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,59 +1060,6 @@ To list all in-progress builds and their build status, use the following command
10601060
viam module build list
10611061
```
10621062

1063-
### `profiles`
1064-
1065-
The `profiles` command allows you to manage different CLI authentication profiles, so you can easily switch between API key authentications (for example authentication to one organization versus another).
1066-
1067-
```sh {class="command-line" data-prompt="$"}
1068-
viam profiles add --profile-name=<name-of-profile-to-add> --key-id=<API-key-ID> --key=<API-key>
1069-
viam profiles update --profile-name=<name-of-profile-to-update> --key-id=<API-key-ID> --key=<API-key>
1070-
viam profiles list
1071-
viam profiles remove --profile-name=<name-of-profile-to-remove>
1072-
```
1073-
1074-
Examples:
1075-
1076-
```sh {id="terminal-prompt" class="command-line" data-prompt="$"}
1077-
# Add a new profile for authentication (throws error if profile already exists)
1078-
viam profiles add --profile-name=mycompany --key-id=54321zyx --key=123abcd1234
1079-
1080-
# Update an existing profile for authentication, or add it if it doesn't exist
1081-
viam profiles update --key=123abcd1234 --key-id=54321zyx --profile-name=mycompany
1082-
1083-
# List all existing profiles by name
1084-
viam profiles list
1085-
1086-
# Remove a profile
1087-
viam profiles remove --profile-name=mycompany
1088-
```
1089-
1090-
See [create an organization API key](#create-an-organization-api-key) for more information.
1091-
1092-
{{% alert title="Tip" color="tip" %}}
1093-
You can set a default profile by using the `VIAM_CLI_PROFILE_NAME` environment variable.
1094-
{{% /alert %}}
1095-
1096-
#### Command options
1097-
1098-
<!-- prettier-ignore -->
1099-
| Command option | Description | Positional arguments |
1100-
| -------------- | ----------- | -------------------- |
1101-
| `add` | List all existing profiles by name. | - |
1102-
| `update` | Update an existing profile for authentication, or add it if it doesn't exist. | - |
1103-
| `list` | List all existing profiles by name. | - |
1104-
| `remove` | Remove a profile. | - |
1105-
| `--help` | Return help | - |
1106-
1107-
##### Named arguments
1108-
1109-
<!-- prettier-ignore -->
1110-
| Argument | Description | Applicable commands | Required? |
1111-
| -------- | ----------- | ------------------- | --------- |
1112-
| `--profile-name` | Name of the profile to add, update, or remove. | `add`, `update`, `remove` | **Required** |
1113-
| `--key-id` | The `key id` (UUID) of the API key. | `add`, `update` | **Required** |
1114-
| `--key` | The `key value` of the API key. | `api-key`, `update` | **Required** |
1115-
11161063
### `organizations`
11171064

11181065
The `organizations` command allows you to list the organizations your authenticated session has access to, and to create a new organization API key.
@@ -1218,6 +1165,59 @@ viam packages export --org-id=123 --name=MyMLModel --version=latest --type=ml_mo
12181165
| `--path` | The path to the package for upload. The package should be zipped with tar and have the `.tar.gz` extension. | `upload` | **Required** |
12191166
| `--destination` | The output directory for downloaded package. | `export` | **Required** |
12201167

1168+
### `profiles`
1169+
1170+
The `profiles` command allows you to manage different CLI authentication profiles, so you can easily switch between API key authentications (for example authentication to one organization versus another).
1171+
1172+
```sh {class="command-line" data-prompt="$"}
1173+
viam profiles add --profile-name=<name-of-profile-to-add> --key-id=<API-key-ID> --key=<API-key>
1174+
viam profiles update --profile-name=<name-of-profile-to-update> --key-id=<API-key-ID> --key=<API-key>
1175+
viam profiles list
1176+
viam profiles remove --profile-name=<name-of-profile-to-remove>
1177+
```
1178+
1179+
Examples:
1180+
1181+
```sh {id="terminal-prompt" class="command-line" data-prompt="$"}
1182+
# Add a new profile for authentication (throws error if profile already exists)
1183+
viam profiles add --profile-name=mycompany --key-id=54321zyx --key=123abcd1234
1184+
1185+
# Update an existing profile for authentication, or add it if it doesn't exist
1186+
viam profiles update --key=123abcd1234 --key-id=54321zyx --profile-name=mycompany
1187+
1188+
# List all existing profiles by name
1189+
viam profiles list
1190+
1191+
# Remove a profile
1192+
viam profiles remove --profile-name=mycompany
1193+
```
1194+
1195+
See [create an organization API key](#create-an-organization-api-key) for more information.
1196+
1197+
{{% alert title="Tip" color="tip" %}}
1198+
You can set a default profile by using the `VIAM_CLI_PROFILE_NAME` environment variable.
1199+
{{% /alert %}}
1200+
1201+
#### Command options
1202+
1203+
<!-- prettier-ignore -->
1204+
| Command option | Description | Positional arguments |
1205+
| -------------- | ----------- | -------------------- |
1206+
| `add` | List all existing profiles by name. | - |
1207+
| `update` | Update an existing profile for authentication, or add it if it doesn't exist. | - |
1208+
| `list` | List all existing profiles by name. | - |
1209+
| `remove` | Remove a profile. | - |
1210+
| `--help` | Return help | - |
1211+
1212+
##### Named arguments
1213+
1214+
<!-- prettier-ignore -->
1215+
| Argument | Description | Applicable commands | Required? |
1216+
| -------- | ----------- | ------------------- | --------- |
1217+
| `--profile-name` | Name of the profile to add, update, or remove. | `add`, `update`, `remove` | **Required** |
1218+
| `--key-id` | The `key id` (UUID) of the API key. | `add`, `update` | **Required** |
1219+
| `--key` | The `key value` of the API key. | `api-key`, `update` | **Required** |
1220+
12211221
### `machines` (alias `robots`)
12221222

12231223
The `machines` command allows you to manage your machine fleet.

0 commit comments

Comments
 (0)