Skip to content

Commit 8690ae0

Browse files
committed
DOCS-3488: Add tunnel command to CLI
1 parent 6c7f9be commit 8690ae0

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/dev/tools/cli.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1213,6 +1213,9 @@ viam.service.vision.v1.VisionService.GetClassificationsFromCamera
12131213
# restart a part of a specified machine
12141214
viam machines part restart --machine=123 --part=456
12151215

1216+
# tunnel connections to the specified port on a machine part
1217+
viam machine part tunnel --part=123 --destination-port=1111 --local-port 2222
1218+
12161219
# Copy and a single file to a machine and change the file's name:
12171220
viam machine part cp --organization=my_org --location=my_location --machine=my_machine --part=m1-main my_file machine:/home/user/
12181221

@@ -1241,7 +1244,7 @@ viam machine part cp --machine=123 --part=123 -r -p machine:my_dir machine:my_fi
12411244
| `api-key` | Work with an api-key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
12421245
| `status` | Retrieve machine status for a specified machine | - |
12431246
| `logs` | Retrieve logs for a specified machine | - |
1244-
| `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. |
1247+
| `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. |
12451248
| `--help` | Return help | - |
12461249

12471250
##### Positional arguments: `api-key`
@@ -1263,6 +1266,7 @@ viam machine part cp --machine=123 --part=123 -r -p machine:my_dir machine:my_fi
12631266
| `shell` | Access a machine part securely using a secure shell. To use this feature you must add the [`ViamShellDanger` fragment](https://app.viam.com/fragment/b511adfa-80ab-4a70-9bd5-fbb14696b17e/json) to your machine. |
12641267
| `restart` | Restart a machine part. |
12651268
| `cp` | Copy files to and from a machine part. |
1269+
| `tunnel` | Tunnel connections to a specified port on a machine part. |
12661270
| `--help` | Return help |
12671271

12681272
##### Named arguments
@@ -1290,6 +1294,8 @@ viam machine part cp --machine=123 --part=123 -r -p machine:my_dir machine:my_fi
12901294
| `--org-id` | The optional organization ID to attach the key to | `api-key` | Optional |
12911295
| `--recursive`, `-r` | Recursively copy files. Default: `false`. | `part cp` | Optional |
12921296
| `--preserve`, `-p` | Preserve modification times and file mode bits from the source files. Default: `false`. | `part cp` | Optional |
1297+
| `--desination-port` | The port on a machine part to tunnel to. Default: `0`. | `part tunnel` | Optional |
1298+
| `--local-port` | The local port from which to tunnel. Default: `0`. | `part tunnel` | Optional |
12931299

12941300
##### Using the `--stream` and `--data` arguments
12951301

0 commit comments

Comments
 (0)