Update Replicated CLI docs for v0.103.0

Author: Replicated Release Pipeline

docs/reference/replicated-cli-cluster-addon-create-object-store.mdx

@@ -7,26 +7,26 @@ Create an object store bucket for a cluster.
 Creates an object store bucket for a cluster, requiring a bucket name prefix. The bucket name will be auto-generated using the format "[BUCKET_PREFIX]-[ADDON_ID]-cmx". This feature provisions an object storage bucket that can be used for storage in your cluster environment.
 
 ```
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix BUCKET_PREFIX [flags]
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix BUCKET_PREFIX [flags]
 ```
 
 ### Examples
 
 ```
 # Create an object store bucket with a specified prefix
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # Create an object store bucket and wait for it to be ready (up to 5 minutes)
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --wait 5m
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --wait 5m
 
 # Perform a dry run to validate inputs without creating the bucket
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --dry-run
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run
 
 # Create an object store bucket and output the result in JSON format
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --output json
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --output json
 
 # Create an object store bucket with a custom prefix and wait for 10 minutes
-replicated cluster addon create object-store 05929b24 --bucket-prefix custom-prefix --wait 10m
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix custom-prefix --wait 10m
 ```
 
 ### Options

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

@@ -10,10 +10,10 @@ Create new add-ons for a cluster. This command allows you to add functionality o
 
 ```
 # Create an object store bucket add-on for a cluster
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # Perform a dry run for creating an object store add-on
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket --dry-run
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run
 ```
 
 ### Options

docs/reference/replicated-cli-cluster-addon-ls.mdx

@@ -9,7 +9,7 @@ The 'cluster addon ls' command allows you to list all add-ons for a specific clu
 This can be useful for monitoring the health and configuration of add-ons or performing troubleshooting tasks.
 
 ```
-replicated cluster addon ls CLUSTER_ID [flags]
+replicated cluster addon ls CLUSTER_ID_OR_NAME [flags]
 ```
 
 ### Aliases
@@ -22,13 +22,13 @@ ls, list
 
 ```
 # List add-ons for a cluster with default table output
-replicated cluster addon ls CLUSTER_ID
+replicated cluster addon ls CLUSTER_ID_OR_NAME
 
 # List add-ons for a cluster with JSON output
-replicated cluster addon ls CLUSTER_ID --output json
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output json
 
 # List add-ons for a cluster with wide table output
-replicated cluster addon ls CLUSTER_ID --output wide
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output wide
 ```
 
 ### Options

docs/reference/replicated-cli-cluster-addon-rm.mdx

@@ -4,12 +4,12 @@ Remove cluster add-on by ID.
 
 ### Synopsis
 
-The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID and the add-on ID.
+The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID or name and the add-on ID.
 
 This command is useful when you want to deprovision an add-on that is no longer needed or when troubleshooting issues related to specific add-ons. The add-on will be removed immediately, and you will receive confirmation upon successful removal.
 
 ```
-replicated cluster addon rm CLUSTER_ID --id ADDON_ID [flags]
+replicated cluster addon rm CLUSTER_ID_OR_NAME --id ADDON_ID [flags]
 ```
 
 ### Aliases

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

@@ -12,16 +12,16 @@ You can use various subcommands to create, list, remove, or check the status of
 
 ```
 # List all add-ons installed on a cluster
-replicated cluster addon ls CLUSTER_ID
+replicated cluster addon ls CLUSTER_ID_OR_NAME
 
 # Remove an add-on from a cluster
-replicated cluster addon rm CLUSTER_ID --id ADDON_ID
+replicated cluster addon rm CLUSTER_ID_OR_NAME --id ADDON_ID
 
 # Create an object store bucket add-on for a cluster
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # List add-ons with JSON output
-replicated cluster addon ls CLUSTER_ID --output json
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output json
 ```
 
 ### Options

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

@@ -6,39 +6,39 @@ Download credentials for a test cluster.
 
 The 'cluster kubeconfig' command downloads the credentials (kubeconfig) required to access a test cluster. You can either merge these credentials into your existing kubeconfig file or save them as a new file.
 
-This command ensures that the kubeconfig is correctly configured for use with your Kubernetes tools. You can specify the cluster by ID or by name. Additionally, the kubeconfig can be written to a specific file path or printed to stdout.
+This command ensures that the kubeconfig is correctly configured for use with your Kubernetes tools. You can specify the cluster by ID or name directly as an argument, or by using the '--id' or '--name' flags. Additionally, the kubeconfig can be written to a specific file path or printed to stdout.
 
 You can also use this command to automatically update your current Kubernetes context with the downloaded credentials.
 
 ```
-replicated cluster kubeconfig [ID] [flags]
+replicated cluster kubeconfig [ID_OR_NAME] [flags]
 ```
 
 ### Examples
 
 ```
 # Download and merge kubeconfig into your existing configuration
-replicated cluster kubeconfig CLUSTER_ID
+replicated cluster kubeconfig CLUSTER_ID_OR_NAME
 
 # Save the kubeconfig to a specific file
-replicated cluster kubeconfig CLUSTER_ID --output-path ./kubeconfig
+replicated cluster kubeconfig CLUSTER_ID_OR_NAME --output-path ./kubeconfig
 
 # Print the kubeconfig to stdout
-replicated cluster kubeconfig CLUSTER_ID --stdout
+replicated cluster kubeconfig CLUSTER_ID_OR_NAME --stdout
 
-# Download kubeconfig for a cluster by name
+# Download kubeconfig for a cluster by name using a flag
 replicated cluster kubeconfig --name "My Cluster"
 
-# Download kubeconfig for a cluster by ID
+# Download kubeconfig for a cluster by ID using a flag
 replicated cluster kubeconfig --id CLUSTER_ID
 ```
 
 ### Options
 
 ```
   -h, --help                 help for kubeconfig
-      --id string            id of the cluster to download credentials for (when name is not provided)
-      --name string          name of the cluster to download credentials for (when id is not provided)
+      --id string            id of the cluster to download credentials for (when name is not provided) (DEPRECATED: use ID_OR_NAME arguments instead)
+      --name string          name of the cluster to download credentials for (when id is not provided) (DEPRECATED: use ID_OR_NAME arguments instead)
       --output-path string   path to kubeconfig file to write to, if not provided, it will be merged into your existing kubeconfig
       --stdout               write kubeconfig to stdout
 ```

docs/reference/replicated-cli-cluster-nodegroup-ls.mdx

@@ -8,10 +8,10 @@ The 'cluster nodegroup ls' command lists all the node groups associated with a g
 
 You can view information about the node groups within the specified cluster, including their ID, name, node count, and other configuration details.
 
-You must provide the cluster ID to list its node groups.
+You must provide the cluster ID or name to list its node groups.
 
 ```
-replicated cluster nodegroup ls [ID] [flags]
+replicated cluster nodegroup ls [ID_OR_NAME] [flags]
 ```
 
 ### Aliases
@@ -24,13 +24,13 @@ ls, list
 
 ```
 # List all node groups in a cluster with default table output
-replicated cluster nodegroup ls CLUSTER_ID
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME
 
 # List node groups with JSON output
-replicated cluster nodegroup ls CLUSTER_ID --output json
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME --output json
 
 # List node groups with wide table output
-replicated cluster nodegroup ls CLUSTER_ID --output wide
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME --output wide
 ```
 
 ### Options

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

@@ -12,7 +12,7 @@ Node groups define a set of nodes with specific configurations, such as instance
 
 ```
 # List all node groups for a cluster
-replicated cluster nodegroup ls CLUSTER_ID
+replicated cluster nodegroup ls CLUSTER_ID_OR_NAME
 ```
 
 ### Options

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

@@ -13,23 +13,23 @@ This command supports different protocols including "http", "https", "ws", and "
 NOTE: Currently, this feature only supports VM-based cluster distributions.
 
 ```
-replicated cluster port expose CLUSTER_ID --port PORT [flags]
+replicated cluster port expose CLUSTER_ID_OR_NAME --port PORT [flags]
 ```
 
 ### Examples
 
 ```
 # Expose port 8080 with HTTPS protocol and wildcard DNS
-replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --wildcard
+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 --port 30000 --protocol http
+replicated cluster port expose CLUSTER_ID_OR_NAME --port 30000 --protocol http
 
 # Expose port 8080 with multiple protocols
-replicated cluster port expose CLUSTER_ID --port 8080 --protocol http,https
+replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol http,https
 
 # Expose port 8080 and display the result in JSON format
-replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --output json
+replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol https --output json
 ```
 
 ### Options

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

@@ -4,12 +4,12 @@ List cluster ports for a cluster.
 
 ### Synopsis
 
-The 'cluster port ls' command lists all the ports configured for a specific cluster. You must provide the cluster ID to retrieve and display the ports.
+The 'cluster port ls' command lists all the ports configured for a specific cluster. You must provide the cluster ID or name to retrieve and display the ports.
 
 This command is useful for viewing the current port configurations, protocols, and other related settings of your test cluster. The output format can be customized to suit your needs, and the available formats include table, JSON, and wide views.
 
 ```
-replicated cluster port ls CLUSTER_ID [flags]
+replicated cluster port ls CLUSTER_ID_OR_NAME [flags]
 ```
 
 ### Aliases
@@ -22,13 +22,13 @@ ls, list
 
 ```
 # List ports for a cluster in the default table format
-replicated cluster port ls CLUSTER_ID
+replicated cluster port ls CLUSTER_ID_OR_NAME
 
 # List ports for a cluster in JSON format
-replicated cluster port ls CLUSTER_ID --output json
+replicated cluster port ls CLUSTER_ID_OR_NAME --output json
 
 # List ports for a cluster in wide format
-replicated cluster port ls CLUSTER_ID --output wide
+replicated cluster port ls CLUSTER_ID_OR_NAME --output wide
 ```
 
 ### Options

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

@@ -4,14 +4,14 @@ Remove cluster port by ID.
 
 ### Synopsis
 
-The 'cluster port rm' command removes a specific port from a cluster. You must provide either the ID of the port or the port number and protocol(s) to remove.
+The 'cluster port rm' command removes a specific port from a cluster. You must provide the ID or name of the cluster and either the ID of the port or the port number and protocol(s) to remove.
 
 This command is useful for managing the network settings of your test clusters by allowing you to clean up unused or incorrect ports. After removing a port, the updated list of ports will be displayed.
 
 Note that you can only use either the port ID or port number when removing a port, not both at the same time.
 
 ```
-replicated cluster port rm CLUSTER_ID --id PORT_ID [flags]
+replicated cluster port rm CLUSTER_ID_OR_NAME --id PORT_ID [flags]
 ```
 
 ### Aliases
@@ -24,13 +24,13 @@ rm, delete
 
 ```
 # Remove a port using its ID
-replicated cluster port rm CLUSTER_ID --id PORT_ID
+replicated cluster port rm CLUSTER_ID_OR_NAME --id PORT_ID
 
 # Remove a port using its number (deprecated)
-replicated cluster port rm CLUSTER_ID --port 8080 --protocol http,https
+replicated cluster port rm CLUSTER_ID_OR_NAME --port 8080 --protocol http,https
 
 # Remove a port and display the result in JSON format
-replicated cluster port rm CLUSTER_ID --id PORT_ID --output json
+replicated cluster port rm CLUSTER_ID_OR_NAME --id PORT_ID --output json
 ```
 
 ### Options

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

@@ -12,13 +12,13 @@ This command provides flexibility for handling ports in various test clusters, e
 
 ```
 # List all exposed ports in a cluster
-replicated cluster port ls [CLUSTER_ID]
+replicated cluster port ls [CLUSTER_ID_OR_NAME]
 
 # Remove an exposed port from a cluster
-replicated cluster port rm [CLUSTER_ID] [PORT]
+replicated cluster port rm [CLUSTER_ID_OR_NAME] [PORT]
 
 # Expose a new port in a cluster
-replicated cluster port expose [CLUSTER_ID] [PORT]
+replicated cluster port expose [CLUSTER_ID_OR_NAME] [PORT]
 ```
 
 ### Options

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

@@ -6,14 +6,16 @@ Remove test clusters.
 
 The 'rm' command removes test clusters immediately.
 
-You can remove clusters by specifying a cluster ID, or by using other criteria such as cluster names or tags. Alternatively, you can remove all clusters in your account at once.
+You can remove clusters by specifying a cluster ID or name, or by using other criteria such as cluster tags. Alternatively, you can remove all clusters in your account at once.
+
+When specifying a name that matches multiple clusters, all clusters with that name will be removed.
 
 This command can also be used in a dry-run mode to simulate the removal without actually deleting anything.
 
-You cannot mix the use of cluster IDs with other options like removing by name, tag, or removing all clusters at once.
+You cannot mix the use of cluster IDs or names with other options like removing by tag or removing all clusters at once.
 
 ```
-replicated cluster rm ID [ID …] [flags]
+replicated cluster rm ID_OR_NAME [ID_OR_NAME …] [flags]
 ```
 
 ### Aliases
@@ -25,8 +27,11 @@ rm, delete
 ### Examples
 
 ```
-# Remove a specific cluster by ID
-replicated cluster rm CLUSTER_ID
+# Remove a specific cluster by ID or name
+replicated cluster rm CLUSTER_ID_OR_NAME
+
+# Remove multiple clusters by ID or name
+replicated cluster rm CLUSTER_ID_1 CLUSTER_NAME_2
 
 # Remove all clusters
 replicated cluster rm --all
@@ -38,7 +43,7 @@ replicated cluster rm --all
       --all                remove all clusters
       --dry-run            Dry run
   -h, --help               help for rm
-      --name stringArray   Name of the cluster to remove (can be specified multiple times)
+      --name stringArray   Name of the cluster to remove (can be specified multiple times) (DEPRECATED: use ID_OR_NAME arguments instead)
       --tag stringArray    Tag of the cluster to remove (key=value format, can be specified multiple times)
 ```
 

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

@@ -6,30 +6,33 @@ Open a new shell with kubeconfig configured.
 
 The 'shell' command opens a new shell session with the kubeconfig configured for the specified test cluster. This allows you to have immediate kubectl access to the cluster within the shell environment.
 
-You can either specify the cluster ID directly or provide the cluster name to resolve the corresponding cluster ID. The shell will inherit your existing environment and add the necessary kubeconfig context for interacting with the Kubernetes cluster.
+You can either specify the cluster ID or name directly as an argument, or provide the cluster name or ID using flags. The shell will inherit your existing environment and add the necessary kubeconfig context for interacting with the Kubernetes cluster.
 
 Once inside the shell, you can use 'kubectl' to interact with the cluster. To exit the shell, press Ctrl-D or type 'exit'. When the shell closes, the kubeconfig will be reset back to your default configuration.
 
 ```
-replicated cluster shell [ID] [flags]
+replicated cluster shell [ID_OR_NAME] [flags]
 ```
 
 ### Examples
 
 ```
-# Open a shell for a cluster by ID
-replicated cluster shell CLUSTER_ID
+# Open a shell for a cluster by ID or name
+replicated cluster shell CLUSTER_ID_OR_NAME
 
-# Open a shell for a cluster by name
+# Open a shell for a cluster by name using a flag
 replicated cluster shell --name "My Cluster"
+
+# Open a shell for a cluster by ID using a flag
+replicated cluster shell --id CLUSTER_ID
 ```
 
 ### Options
 
 ```
   -h, --help          help for shell
-      --id string     id of the cluster to have kubectl access to (when name is not provided)
-      --name string   name of the cluster to have kubectl access to.
+      --id string     id of the cluster to have kubectl access to (when name is not provided) (DEPRECATED: use ID_OR_NAME arguments instead)
+      --name string   name of the cluster to have kubectl access to. (DEPRECATED: use ID_OR_NAME arguments instead)
 ```
 
 ### Options inherited from parent commands