Update Replicated CLI docs for v0.98.2 (#3135)

divolgin · Replicated Release Pipeline · web-flow · commit 6dd116630244 · 2025-03-26T09:42:23.000-07:00
Co-authored-by: Replicated Release Pipeline &lt;release@replicated.com&gt;
diff --git a/docs/reference/replicated-cli-app-create.mdx b/docs/reference/replicated-cli-app-create.mdx
@@ -33,7 +33,7 @@ replicated app create "Custom App" --output table
 
 ```
   -h, --help            help for create
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-app-ls.mdx b/docs/reference/replicated-cli-app-ls.mdx
@@ -44,7 +44,7 @@ replicated app ls "App Name" --output table
 
 ```
   -h, --help            help for ls
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-app-rm.mdx b/docs/reference/replicated-cli-app-rm.mdx
@@ -39,7 +39,7 @@ replicated app delete "Custom App" --output json
 ```
   -f, --force           Skip confirmation prompt. There is no undo for this action.
   -h, --help            help for rm
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-channel-create.mdx b/docs/reference/replicated-cli-channel-create.mdx
@@ -22,7 +22,7 @@ replicated channel create --name Beta --description 'New features subject to cha
       --description string   A longer description of this channel
   -h, --help                 help for create
       --name string          The name of this channel
-      --output string        The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string        The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-channel-inspect.mdx b/docs/reference/replicated-cli-channel-inspect.mdx
@@ -14,7 +14,7 @@ replicated channel inspect CHANNEL_ID [flags]
 
 ```
   -h, --help            help for inspect
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-channel-ls.mdx b/docs/reference/replicated-cli-channel-ls.mdx
@@ -20,7 +20,7 @@ ls, list
 
 ```
   -h, --help            help for ls
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx b/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx
@@ -35,7 +35,7 @@ replicated cluster addon create object-store 05929b24 --bucket-prefix custom-pre
       --bucket-prefix string   A prefix for the bucket name to be created (required)
       --dry-run                Simulate creation to verify that your inputs are valid without actually creating an add-on
   -h, --help                   help for object-store
-      --output string          The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string          The output format to use. One of: json|table|wide (default "table")
       --wait duration          Wait duration for add-on to be ready before exiting (leave empty to not wait)
 ```
 
diff --git a/docs/reference/replicated-cli-cluster-addon-ls.mdx b/docs/reference/replicated-cli-cluster-addon-ls.mdx
@@ -35,7 +35,7 @@ replicated cluster addon ls CLUSTER_ID --output wide
 
 ```
   -h, --help            help for ls
-      --output string   The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table|wide (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-cluster-create.mdx b/docs/reference/replicated-cli-cluster-create.mdx
@@ -59,7 +59,7 @@ replicated cluster create --distribution eks --version 1.21 --nodes 3 --addon ob
       --name string             Cluster name (defaults to random name)
       --nodegroup stringArray   Node group to create (name=?,instance-type=?,nodes=?,min-nodes=?,max-nodes=?,disk=? format, can be specified multiple times). For each nodegroup, at least one flag must be specified. The flags min-nodes and max-nodes are mutually dependent.
       --nodes int               Node count (default 1)
-  -o, --output string           The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string           The output format to use. One of: json|table|wide (default "table")
       --tag stringArray         Tag to apply to the cluster (key=value format, can be specified multiple times)
       --ttl string              Cluster TTL (duration, max 48h)
       --version string          Kubernetes version to provision (format is distribution dependent)
diff --git a/docs/reference/replicated-cli-cluster-ls.mdx b/docs/reference/replicated-cli-cluster-ls.mdx
@@ -47,7 +47,7 @@ replicated cluster ls --output wide
 ```
       --end-time string     end time for the query (Format: 2006-01-02T15:04:05Z)
   -h, --help                help for ls
-  -o, --output string       The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string       The output format to use. One of: json|table|wide (default "table")
       --show-terminated     when set, only show terminated clusters
       --start-time string   start time for the query (Format: 2006-01-02T15:04:05Z)
   -w, --watch               watch clusters
diff --git a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx
@@ -37,7 +37,7 @@ replicated cluster nodegroup ls CLUSTER_ID --output wide
 
 ```
   -h, --help            help for ls
-  -o, --output string   The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table|wide (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-cluster-port-expose.mdx b/docs/reference/replicated-cli-cluster-port-expose.mdx
@@ -36,7 +36,7 @@ replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --output
 
 ```
   -h, --help               help for expose
-  -o, --output string      The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string      The output format to use. One of: json|table|wide (default "table")
       --port int           Port to expose (required)
       --protocol strings   Protocol to expose (valid values are "http", "https", "ws" and "wss") (default [http,https])
       --wildcard           Create a wildcard DNS entry and TLS certificate for this port
diff --git a/docs/reference/replicated-cli-cluster-port-ls.mdx b/docs/reference/replicated-cli-cluster-port-ls.mdx
@@ -35,7 +35,7 @@ replicated cluster port ls CLUSTER_ID --output wide
 
 ```
   -h, --help            help for ls
-  -o, --output string   The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table|wide (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-cluster-port-rm.mdx b/docs/reference/replicated-cli-cluster-port-rm.mdx
@@ -38,7 +38,7 @@ replicated cluster port rm CLUSTER_ID --id PORT_ID --output json
 ```
   -h, --help            help for rm
       --id string       ID of the port to remove (required)
-  -o, --output string   The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table|wide (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-cluster-update-nodegroup.mdx b/docs/reference/replicated-cli-cluster-update-nodegroup.mdx
@@ -31,7 +31,7 @@ replicated cluster update nodegroup CLUSTER_ID --nodegroup-id NODEGROUP_ID --min
       --nodegroup-id string     The ID of the nodegroup to update
       --nodegroup-name string   The name of the nodegroup to update
       --nodes int               The number of nodes in the nodegroup
-  -o, --output string           The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string           The output format to use. One of: json|table|wide (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-cluster-update-ttl.mdx b/docs/reference/replicated-cli-cluster-update-ttl.mdx
@@ -21,7 +21,7 @@ replicated cluster update ttl CLUSTER_ID --ttl 24h
 
 ```
   -h, --help            help for ttl
-  -o, --output string   The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
       --ttl string      Update TTL which starts from the moment the cluster is running (duration, max 48h).
 ```
 
diff --git a/docs/reference/replicated-cli-cluster-upgrade.mdx b/docs/reference/replicated-cli-cluster-upgrade.mdx
@@ -28,7 +28,7 @@ replicated cluster upgrade [CLUSTER_ID] --version 1.31 --wait 30m
 ```
       --dry-run          Dry run
   -h, --help             help for upgrade
-  -o, --output string    The output format to use. One of: json|table|wide (default: table) (default "table")
+  -o, --output string    The output format to use. One of: json|table|wide (default "table")
       --version string   Kubernetes version to upgrade to (format is distribution dependent)
       --wait duration    Wait duration for cluster to be ready (leave empty to not wait)
 ```
diff --git a/docs/reference/replicated-cli-cluster-versions.mdx b/docs/reference/replicated-cli-cluster-versions.mdx
@@ -28,7 +28,7 @@ replicated cluster versions --output json
 ```
       --distribution string   Kubernetes distribution to filter by.
   -h, --help                  help for versions
-      --output string         The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string         The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-customer-create.mdx b/docs/reference/replicated-cli-customer-create.mdx
@@ -61,7 +61,7 @@ replicated customer create --app myapp --name "Full Options Inc" --custom-id "FU
       --kots-install                If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
       --kurl-install                If set, the license will allow kURL installs.
       --name string                 Name of the customer
-      --output string               The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string               The output format to use. One of: json|table (default "table")
       --snapshot                    If set, the license will allow Snapshots.
       --support-bundle-upload       If set, the license will allow uploading support bundles.
       --type string                 The license type to create. One of: dev|trial|paid|community|test (default: dev) (default "dev")
diff --git a/docs/reference/replicated-cli-customer-inspect.mdx b/docs/reference/replicated-cli-customer-inspect.mdx
@@ -37,7 +37,7 @@ replicated customer inspect --app myapp --customer "Acme Inc"
 ```
       --customer string   The Customer Name or ID
   -h, --help              help for inspect
-      --output string     The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string     The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-customer-ls.mdx b/docs/reference/replicated-cli-customer-ls.mdx
@@ -42,7 +42,7 @@ replicated customer ls --app myapp --output json
       --app-version string   Filter customers by a specific app version
   -h, --help                 help for ls
       --include-test         Include test customers in the results
-      --output string        Output format: json|table (default: table) (default "table")
+  -o, --output string        The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-customer-update.mdx b/docs/reference/replicated-cli-customer-update.mdx
@@ -60,7 +60,7 @@ replicated customer update --customer cus_abcdef123456 --name "JSON Corp" --outp
       --kots-install                If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
       --kurl-install                If set, the license will allow kURL installs.
       --name string                 Name of the customer
-      --output string               The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string               The output format to use. One of: json|table (default "table")
       --snapshot                    If set, the license will allow Snapshots.
       --support-bundle-upload       If set, the license will allow uploading support bundles.
       --type string                 The license type to update. One of: dev|trial|paid|community|test (default: dev) (default "dev")
diff --git a/docs/reference/replicated-cli-default-set.mdx b/docs/reference/replicated-cli-default-set.mdx
@@ -29,7 +29,7 @@ replicated default set app my-app-slug
 
 ```
   -h, --help            help for set
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-default-show.mdx b/docs/reference/replicated-cli-default-show.mdx
@@ -30,7 +30,7 @@ replicated default show app
 
 ```
   -h, --help            help for show
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-installer-ls.mdx b/docs/reference/replicated-cli-installer-ls.mdx
@@ -20,7 +20,7 @@ ls, list
 
 ```
   -h, --help            help for ls
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-instance-inspect.mdx b/docs/reference/replicated-cli-instance-inspect.mdx
@@ -16,7 +16,7 @@ replicated instance inspect [flags]
       --customer string   Customer Name or ID
   -h, --help              help for inspect
       --instance string   Instance Name or ID
-      --output string     The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string     The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-instance-ls.mdx b/docs/reference/replicated-cli-instance-ls.mdx
@@ -21,7 +21,7 @@ ls, list
 ```
       --customer string   Customer Name or ID
   -h, --help              help for ls
-      --output string     The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string     The output format to use. One of: json|table (default "table")
       --tag stringArray   Tags to use to filter instances (key=value format, can be specified multiple times). Only one tag needs to match (an OR operation)
 ```
 
diff --git a/docs/reference/replicated-cli-instance-tag.mdx b/docs/reference/replicated-cli-instance-tag.mdx
@@ -16,7 +16,7 @@ replicated instance tag [flags]
       --customer string   Customer Name or ID
   -h, --help              help for tag
       --instance string   Instance Name or ID
-      --output string     The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string     The output format to use. One of: json|table (default "table")
       --tag stringArray   Tags to apply to instance. Leave value empty to remove tag. Tags not specified will not be removed.
 ```
 
diff --git a/docs/reference/replicated-cli-registry-add-dockerhub.mdx b/docs/reference/replicated-cli-registry-add-dockerhub.mdx
@@ -15,7 +15,7 @@ replicated registry add dockerhub [flags]
 ```
       --authtype string   Auth type for the registry (default "password")
   -h, --help              help for dockerhub
-      --output string     The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string     The output format to use. One of: json|table (default "table")
       --password string   The password to authenticate to the registry with
       --password-stdin    Take the password from stdin
       --token string      The token to authenticate to the registry with
diff --git a/docs/reference/replicated-cli-registry-add-ecr.mdx b/docs/reference/replicated-cli-registry-add-ecr.mdx
@@ -16,7 +16,7 @@ replicated registry add ecr [flags]
       --accesskeyid string       The access key id to authenticate to the registry with
       --endpoint string          The ECR endpoint
   -h, --help                     help for ecr
-      --output string            The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string            The output format to use. One of: json|table (default "table")
       --secretaccesskey string   The secret access key to authenticate to the registry with
       --secretaccesskey-stdin    Take the secret access key from stdin
 ```
diff --git a/docs/reference/replicated-cli-registry-add-gar.mdx b/docs/reference/replicated-cli-registry-add-gar.mdx
@@ -16,7 +16,7 @@ replicated registry add gar [flags]
       --authtype string            Auth type for the registry (default "serviceaccount")
       --endpoint string            The GAR endpoint
   -h, --help                       help for gar
-      --output string              The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string              The output format to use. One of: json|table (default "table")
       --serviceaccountkey string   The service account key to authenticate to the registry with
       --serviceaccountkey-stdin    Take the service account key from stdin
       --token string               The token to use to auth to the registry with
diff --git a/docs/reference/replicated-cli-registry-add-gcr.mdx b/docs/reference/replicated-cli-registry-add-gcr.mdx
@@ -15,7 +15,7 @@ replicated registry add gcr [flags]
 ```
       --endpoint string            The GCR endpoint
   -h, --help                       help for gcr
-      --output string              The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string              The output format to use. One of: json|table (default "table")
       --serviceaccountkey string   The service account key to authenticate to the registry with
       --serviceaccountkey-stdin    Take the service account key from stdin
 ```
diff --git a/docs/reference/replicated-cli-registry-add-ghcr.mdx b/docs/reference/replicated-cli-registry-add-ghcr.mdx
@@ -14,7 +14,7 @@ replicated registry add ghcr [flags]
 
 ```
   -h, --help            help for ghcr
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
       --token string    The token to use to auth to the registry with
       --token-stdin     Take the token from stdin
 ```
diff --git a/docs/reference/replicated-cli-registry-add-other.mdx b/docs/reference/replicated-cli-registry-add-other.mdx
@@ -15,7 +15,7 @@ replicated registry add other [flags]
 ```
       --endpoint string   endpoint for the registry
   -h, --help              help for other
-      --output string     The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string     The output format to use. One of: json|table (default "table")
       --password string   The password to authenticate to the registry with
       --password-stdin    Take the password from stdin
       --username string   The userame to authenticate to the registry with
diff --git a/docs/reference/replicated-cli-registry-add-quay.mdx b/docs/reference/replicated-cli-registry-add-quay.mdx
@@ -14,7 +14,7 @@ replicated registry add quay [flags]
 
 ```
   -h, --help              help for quay
-      --output string     The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string     The output format to use. One of: json|table (default "table")
       --password string   The password to authenticate to the registry with
       --password-stdin    Take the password from stdin
       --username string   The userame to authenticate to the registry with
diff --git a/docs/reference/replicated-cli-registry-ls.mdx b/docs/reference/replicated-cli-registry-ls.mdx
@@ -20,7 +20,7 @@ ls, list
 
 ```
   -h, --help            help for ls
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-release-inspect.mdx b/docs/reference/replicated-cli-release-inspect.mdx
@@ -30,7 +30,7 @@ replicated release inspect 123 --output json
 
 ```
   -h, --help            help for inspect
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-release-lint.mdx b/docs/reference/replicated-cli-release-lint.mdx
@@ -15,7 +15,7 @@ replicated release lint [flags]
 ```
       --fail-on string   The minimum severity to cause the command to exit with a non-zero exit code. Supported values are [info, warn, error, none]. (default "error")
   -h, --help             help for lint
-      --output string    The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string    The output format to use. One of: json|table (default "table")
       --yaml-dir yaml    The directory containing multiple yamls for a Kots release.  Cannot be used with the yaml flag.
 ```
 
diff --git a/docs/reference/replicated-cli-release-ls.mdx b/docs/reference/replicated-cli-release-ls.mdx
@@ -20,7 +20,7 @@ ls, list
 
 ```
   -h, --help            help for ls
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands
diff --git a/docs/reference/replicated-cli-vm-create.mdx b/docs/reference/replicated-cli-vm-create.mdx
diff --git a/docs/reference/replicated-cli-vm-ls.mdx b/docs/reference/replicated-cli-vm-ls.mdx
diff --git a/docs/reference/replicated-cli-vm-port-expose.mdx b/docs/reference/replicated-cli-vm-port-expose.mdx
diff --git a/docs/reference/replicated-cli-vm-port-ls.mdx b/docs/reference/replicated-cli-vm-port-ls.mdx
diff --git a/docs/reference/replicated-cli-vm-port-rm.mdx b/docs/reference/replicated-cli-vm-port-rm.mdx
diff --git a/docs/reference/replicated-cli-vm-update-ttl.mdx b/docs/reference/replicated-cli-vm-update-ttl.mdx
diff --git a/docs/reference/replicated-cli-vm-versions.mdx b/docs/reference/replicated-cli-vm-versions.mdx
