Skip to content

Update Replicated CLI docs for v0.104.0 #3236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/reference/replicated-cli-cluster-port-expose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ replicated cluster port expose CLUSTER_ID_OR_NAME --port PORT [flags]
### Examples

```
# Expose port for Embedded Cluster (Port: 30000) with HTTP Protocol
replicated cluster port expose CLUSTER_ID_OR_NAME --port 30000 --protocol http

# Expose port 8080 with HTTPS protocol and wildcard DNS
replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol https --wildcard

# Expose port 30000 with HTTP protocol
replicated cluster port expose CLUSTER_ID_OR_NAME --port 30000 --protocol http

# Expose port 8080 with multiple protocols
replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol http,https

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/replicated-cli-vm-port-expose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ replicated vm port expose VM_ID_OR_NAME --port PORT [flags]
### Examples

```
# Expose port for Embedded Cluster (Port: 30000) with HTTP Protocol
replicated vm port expose VM_ID_OR_NAME --port 30000 --protocol http

# Expose port 8080 with HTTPS protocol
replicated vm port expose VM_ID_OR_NAME --port 8080 --protocol https

# Expose port 30000 with HTTP protocol
replicated vm port expose VM_ID_OR_NAME --port 30000 --protocol http

# Expose port 8080 with multiple protocols
replicated vm port expose VM_ID_OR_NAME --port 8080 --protocol http,https

Expand Down
46 changes: 46 additions & 0 deletions docs/reference/replicated-cli-vm-scp-endpoint.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# replicated vm scp-endpoint

Get the SCP endpoint of a VM

### Synopsis

Get the SCP endpoint and port of a VM.

The output will be in the format: scp://username@hostname:port

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

Note: SCP endpoints can only be retrieved from VMs in the "running" state.

```
replicated vm scp-endpoint VM_ID_OR_NAME [flags]
```

### Examples

```
# Get SCP endpoint for a specific VM by ID
replicated vm scp-endpoint aaaaa11

# Get SCP endpoint for a specific VM by name
replicated vm scp-endpoint my-test-vm
```

### Options

```
-h, --help help for scp-endpoint
```

### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--debug Enable debug output
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated vm](replicated-cli-vm) - Manage test virtual machines.

2 changes: 1 addition & 1 deletion docs/reference/replicated-cli-vm-ssh-endpoint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Get the SSH endpoint of a VM

Get the SSH endpoint and port of a VM.

The output will be in the format: hostname:port
The output will be in the format: ssh://username@hostname:port

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

Expand Down
1 change: 1 addition & 0 deletions docs/reference/replicated-cli-vm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ replicated vm update ttl <vm-id> --ttl 24h
* [replicated vm ls](replicated-cli-vm-ls) - List test VMs and their status, with optional filters for start/end time and terminated VMs.
* [replicated vm port](replicated-cli-vm-port) - Manage VM ports.
* [replicated vm rm](replicated-cli-vm-rm) - Remove test VM(s) immediately, with options to filter by name, tag, or remove all VMs.
* [replicated vm scp-endpoint](replicated-cli-vm-scp-endpoint) - Get the SCP endpoint of a VM
* [replicated vm ssh-endpoint](replicated-cli-vm-ssh-endpoint) - Get the SSH endpoint of a VM
* [replicated vm update](replicated-cli-vm-update) - Update VM settings.
* [replicated vm versions](replicated-cli-vm-versions) - List available VM versions.
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,7 @@ const sidebars = {
'reference/replicated-cli-vm-port-ls',
'reference/replicated-cli-vm-port-rm',
'reference/replicated-cli-vm-rm',
'reference/replicated-cli-vm-scp-endpoint',
'reference/replicated-cli-vm-ssh-endpoint',
'reference/replicated-cli-vm-update',
'reference/replicated-cli-vm-update-ttl',
Expand Down