Merge pull request #3219 from replicatedhq/update-cli-docs-v0.102.0-2025-04-30-222350

Update Replicated CLI docs for v0.102.0

Author: AmberAlston

docs/reference/replicated-cli-cluster-create.mdx

@@ -6,7 +6,7 @@ Create test clusters.
 
 The 'cluster create' command provisions a new test cluster with the specified Kubernetes distribution and configuration. You can customize the cluster's size, version, node groups, disk space, IP family, and other parameters.
 
-This command supports creating clusters on multiple Kubernetes distributions, including setting up node groups with different instance types and counts. You can also specify a TTL (Time-To-Live) to automatically terminate the cluster after a set duration.
+This command supports creating clusters on multiple Kubernetes distributions, including setting up node groups with different instance types and counts. You can also specify a TTL (Time-To-Live) to automatically terminate the cluster after a set duration. If no TTL is specified, the default TTL is 1 hour.
 
 Use the '--dry-run' flag to simulate the creation process and get an estimated cost without actually provisioning the cluster.
 

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

@@ -22,8 +22,8 @@ replicated cluster port expose CLUSTER_ID --port PORT [flags]
 # Expose port 8080 with HTTPS protocol and wildcard DNS
 replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --wildcard
 
-# Expose port 3000 with HTTP protocol
-replicated cluster port expose CLUSTER_ID --port 3000 --protocol http
+# Expose port 30000 with HTTP protocol
+replicated cluster port expose CLUSTER_ID --port 30000 --protocol http
 
 # Expose port 8080 with multiple protocols
 replicated cluster port expose CLUSTER_ID --port 8080 --protocol http,https

docs/reference/replicated-cli-cluster-update-ttl.mdx

@@ -4,7 +4,7 @@ Update TTL for a test cluster.
 
 ### Synopsis
 
-The 'ttl' command allows you to update the Time-To-Live (TTL) of a test cluster. The TTL represents the duration for which the cluster will remain active before it is automatically terminated. The duration starts from the moment the cluster becomes active. You must provide a valid duration, with a maximum limit of 48 hours.
+The 'ttl' command allows you to update the Time-To-Live (TTL) of a test cluster. The TTL represents the duration for which the cluster will remain active before it is automatically terminated. The duration starts from the moment the cluster becomes active. You must provide a valid duration, with a maximum limit of 48 hours. If no TTL is specified, the default TTL is 1 hour.
 
 ```
 replicated cluster update ttl [ID] [flags]

docs/reference/replicated-cli-vm-create.mdx

@@ -6,7 +6,7 @@ Create one or more test VMs with specified distribution, version, and configurat
 
 Create one or more test VMs with a specified distribution, version, and a variety of customizable configuration options.
 
-This command allows you to provision VMs with different distributions (e.g., Ubuntu, RHEL), versions, instance types, and more. You can set the number of VMs to create, disk size, and specify the network to use. If no network is provided, a new network will be created automatically. You can also assign tags to your VMs and use a TTL (Time-To-Live) to define how long the VMs should live.
+This command allows you to provision VMs with different distributions (e.g., Ubuntu, RHEL), versions, instance types, and more. You can set the number of VMs to create, disk size, and specify the network to use. If no network is provided, a new network will be created automatically. You can also assign tags to your VMs and use a TTL (Time-To-Live) to define how long the VMs should live. If no TTL is specified, the default TTL is 1 hour.
 
 By default, the command provisions one VM, but you can customize the number of VMs to create by using the "--count" flag. Additionally, you can use the "--dry-run" flag to simulate the creation without actually provisioning the VMs.
 
@@ -27,24 +27,31 @@ replicated vm create --distribution ubuntu --version 22.04 --count 3
 
 # Create 5 Ubuntu VMs with a custom instance type and disk size
 replicated vm create --distribution ubuntu --version 20.04 --count 5 --instance-type r1.medium --disk 100
+
+# Create a VM with an SSH public key
+replicated vm create --distribution ubuntu --version 20.04 --ssh-public-key ~/.ssh/id_rsa.pub
+
+# Create a VM with multiple SSH public keys
+replicated vm create --distribution ubuntu --version 20.04 --ssh-public-key ~/.ssh/id_rsa.pub --ssh-public-key ~/.ssh/id_ed25519.pub
 ```
 
 ### Options
 
 ```
-      --count int              Number of matching VMs to create (default 1)
-      --disk int               Disk Size (GiB) to request per node (default 50)
-      --distribution string    Distribution of the VM to provision
-      --dry-run                Dry run
-  -h, --help                   help for create
-      --instance-type string   The type of instance to use (e.g. r1.medium)
-      --name string            VM name (defaults to random name)
-      --network string         The network to use for the VM(s). If not supplied, create a new network
-  -o, --output string          The output format to use. One of: json|table|wide (default "table")
-      --tag stringArray        Tag to apply to the VM (key=value format, can be specified multiple times)
-      --ttl string             VM TTL (duration, max 48h)
-      --version string         Version to provision (format is distribution dependent)
-      --wait duration          Wait duration for VM(s) to be ready (leave empty to not wait)
+      --count int                    Number of matching VMs to create (default 1)
+      --disk int                     Disk Size (GiB) to request per node (default 50)
+      --distribution string          Distribution of the VM to provision
+      --dry-run                      Dry run
+  -h, --help                         help for create
+      --instance-type string         The type of instance to use (e.g. r1.medium)
+      --name string                  VM name (defaults to random name)
+      --network string               The network to use for the VM(s). If not supplied, create a new network
+  -o, --output string                The output format to use. One of: json|table|wide (default "table")
+      --ssh-public-key stringArray   Path to SSH public key file to add to the VM (can be specified multiple times)
+      --tag stringArray              Tag to apply to the VM (key=value format, can be specified multiple times)
+      --ttl string                   VM TTL (duration, max 48h)
+      --version string               Version to provision (format is distribution dependent)
+      --wait duration                Wait duration for VM(s) to be ready (leave empty to not wait)
 ```
 
 ### Options inherited from parent commands

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

@@ -18,8 +18,8 @@ replicated vm port expose VM_ID --port PORT [flags]
 # Expose port 8080 with HTTPS protocol
 replicated vm port expose VM_ID --port 8080 --protocol https
 
-# Expose port 3000 with HTTP protocol
-replicated vm port expose VM_ID --port 3000 --protocol http
+# Expose port 30000 with HTTP protocol
+replicated vm port expose VM_ID --port 30000 --protocol http
 
 # Expose port 8080 with multiple protocols
 replicated vm port expose VM_ID --port 8080 --protocol http,https

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

@@ -8,15 +8,22 @@ Get the SSH endpoint and port of a VM.
 
 The output will be in the format: hostname:port
 
+You can identify the VM either by its unique ID or by its name.
+
+Note: SSH endpoints can only be retrieved from VMs in the "running" state.
+
 ```
-replicated vm ssh-endpoint VM_ID [flags]
+replicated vm ssh-endpoint VM_ID_OR_NAME [flags]
 ```
 
 ### Examples
 
 ```
 # Get SSH endpoint for a specific VM by ID
-replicated vm ssh-endpoint <id>
+replicated vm ssh-endpoint aaaaa11
+
+# Get SSH endpoint for a specific VM by name
+replicated vm ssh-endpoint my-test-vm
 ```
 
 ### Options

docs/reference/replicated-cli-vm-update-ttl.mdx

@@ -6,7 +6,7 @@ Update TTL for a test VM.
 
 The 'ttl' command allows you to update the Time to Live (TTL) for a test VM. This command modifies the lifespan of a running VM by updating its TTL, which is a duration starting from the moment the VM is provisioned.
 
-The TTL specifies how long the VM will run before it is automatically terminated. You can specify a duration up to a maximum of 48 hours.
+The TTL specifies how long the VM will run before it is automatically terminated. You can specify a duration up to a maximum of 48 hours. If no TTL is specified, the default TTL is 1 hour.
 
 The command accepts a VM ID as an argument and requires the '--ttl' flag to specify the new TTL value.