Skip to content

Commit ee12867

Browse files
divolginReplicated Release Pipeline
and
Replicated Release Pipeline
authored
Update Replicated CLI docs for v0.104.0 (#3236)
Co-authored-by: Replicated Release Pipeline <[email protected]>
1 parent a9920d9 commit ee12867

6 files changed

+55
-7
lines changed

docs/reference/replicated-cli-cluster-port-expose.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ replicated cluster port expose CLUSTER_ID_OR_NAME --port PORT [flags]
1919
### Examples
2020

2121
```
22+
# Expose port for Embedded Cluster (Port: 30000) with HTTP Protocol
23+
replicated cluster port expose CLUSTER_ID_OR_NAME --port 30000 --protocol http
24+
2225
# Expose port 8080 with HTTPS protocol and wildcard DNS
2326
replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol https --wildcard
2427
25-
# Expose port 30000 with HTTP protocol
26-
replicated cluster port expose CLUSTER_ID_OR_NAME --port 30000 --protocol http
27-
2828
# Expose port 8080 with multiple protocols
2929
replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol http,https
3030

docs/reference/replicated-cli-vm-port-expose.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ replicated vm port expose VM_ID_OR_NAME --port PORT [flags]
1515
### Examples
1616

1717
```
18+
# Expose port for Embedded Cluster (Port: 30000) with HTTP Protocol
19+
replicated vm port expose VM_ID_OR_NAME --port 30000 --protocol http
20+
1821
# Expose port 8080 with HTTPS protocol
1922
replicated vm port expose VM_ID_OR_NAME --port 8080 --protocol https
2023
21-
# Expose port 30000 with HTTP protocol
22-
replicated vm port expose VM_ID_OR_NAME --port 30000 --protocol http
23-
2424
# Expose port 8080 with multiple protocols
2525
replicated vm port expose VM_ID_OR_NAME --port 8080 --protocol http,https
2626
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# replicated vm scp-endpoint
2+
3+
Get the SCP endpoint of a VM
4+
5+
### Synopsis
6+
7+
Get the SCP endpoint and port of a VM.
8+
9+
The output will be in the format: scp://username@hostname:port
10+
11+
You can identify the VM either by its unique ID or by its name.
12+
13+
Note: SCP endpoints can only be retrieved from VMs in the "running" state.
14+
15+
```
16+
replicated vm scp-endpoint VM_ID_OR_NAME [flags]
17+
```
18+
19+
### Examples
20+
21+
```
22+
# Get SCP endpoint for a specific VM by ID
23+
replicated vm scp-endpoint aaaaa11
24+
25+
# Get SCP endpoint for a specific VM by name
26+
replicated vm scp-endpoint my-test-vm
27+
```
28+
29+
### Options
30+
31+
```
32+
-h, --help help for scp-endpoint
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
--app string The app slug or app id to use in all calls
39+
--debug Enable debug output
40+
--token string The API token to use to access your app in the Vendor API
41+
```
42+
43+
### SEE ALSO
44+
45+
* [replicated vm](replicated-cli-vm) - Manage test virtual machines.
46+

docs/reference/replicated-cli-vm-ssh-endpoint.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Get the SSH endpoint of a VM
66

77
Get the SSH endpoint and port of a VM.
88

9-
The output will be in the format: hostname:port
9+
The output will be in the format: ssh://username@hostname:port
1010

1111
You can identify the VM either by its unique ID or by its name.
1212

docs/reference/replicated-cli-vm.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ replicated vm update ttl <vm-id> --ttl 24h
4343
* [replicated vm ls](replicated-cli-vm-ls) - List test VMs and their status, with optional filters for start/end time and terminated VMs.
4444
* [replicated vm port](replicated-cli-vm-port) - Manage VM ports.
4545
* [replicated vm rm](replicated-cli-vm-rm) - Remove test VM(s) immediately, with options to filter by name, tag, or remove all VMs.
46+
* [replicated vm scp-endpoint](replicated-cli-vm-scp-endpoint) - Get the SCP endpoint of a VM
4647
* [replicated vm ssh-endpoint](replicated-cli-vm-ssh-endpoint) - Get the SSH endpoint of a VM
4748
* [replicated vm update](replicated-cli-vm-update) - Update VM settings.
4849
* [replicated vm versions](replicated-cli-vm-versions) - List available VM versions.

sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -722,6 +722,7 @@ const sidebars = {
722722
'reference/replicated-cli-vm-port-ls',
723723
'reference/replicated-cli-vm-port-rm',
724724
'reference/replicated-cli-vm-rm',
725+
'reference/replicated-cli-vm-scp-endpoint',
725726
'reference/replicated-cli-vm-ssh-endpoint',
726727
'reference/replicated-cli-vm-update',
727728
'reference/replicated-cli-vm-update-ttl',

0 commit comments

Comments
 (0)