diff --git a/docs/reference/replicated-cli-api-get.mdx b/docs/reference/replicated-cli-api-get.mdx index 37c209516c..b2e12ece36 100644 --- a/docs/reference/replicated-cli-api-get.mdx +++ b/docs/reference/replicated-cli-api-get.mdx @@ -31,6 +31,7 @@ replicated api get /v3/apps ``` --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 ``` diff --git a/docs/reference/replicated-cli-api-patch.mdx b/docs/reference/replicated-cli-api-patch.mdx index 95abc49058..aba1389017 100644 --- a/docs/reference/replicated-cli-api-patch.mdx +++ b/docs/reference/replicated-cli-api-patch.mdx @@ -32,6 +32,7 @@ replicated api patch /v3/customer/2VffY549paATVfHSGpJhjh6Ehpy -b '{"name":"Valua ``` --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 ``` diff --git a/docs/reference/replicated-cli-api-post.mdx b/docs/reference/replicated-cli-api-post.mdx index 97d526b15b..3bfead03d9 100644 --- a/docs/reference/replicated-cli-api-post.mdx +++ b/docs/reference/replicated-cli-api-post.mdx @@ -32,6 +32,7 @@ replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"mar ``` --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 ``` diff --git a/docs/reference/replicated-cli-api-put.mdx b/docs/reference/replicated-cli-api-put.mdx index ef66438d7e..f2e4033196 100644 --- a/docs/reference/replicated-cli-api-put.mdx +++ b/docs/reference/replicated-cli-api-put.mdx @@ -32,6 +32,7 @@ replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z ``` --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 ``` diff --git a/docs/reference/replicated-cli-api.mdx b/docs/reference/replicated-cli-api.mdx index 39391062c4..48a10ec47b 100644 --- a/docs/reference/replicated-cli-api.mdx +++ b/docs/reference/replicated-cli-api.mdx @@ -12,6 +12,7 @@ Make ad-hoc API calls to the Replicated API ``` --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 ``` diff --git a/docs/reference/replicated-cli-app-create.mdx b/docs/reference/replicated-cli-app-create.mdx index 82e0b6c5cc..d90cd948e9 100644 --- a/docs/reference/replicated-cli-app-create.mdx +++ b/docs/reference/replicated-cli-app-create.mdx @@ -40,6 +40,7 @@ replicated app create "Custom App" --output table ``` --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 ``` diff --git a/docs/reference/replicated-cli-app-ls.mdx b/docs/reference/replicated-cli-app-ls.mdx index 09688a8cda..22d944d6ae 100644 --- a/docs/reference/replicated-cli-app-ls.mdx +++ b/docs/reference/replicated-cli-app-ls.mdx @@ -51,6 +51,7 @@ replicated app ls "App Name" --output table ``` --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 ``` diff --git a/docs/reference/replicated-cli-app-rm.mdx b/docs/reference/replicated-cli-app-rm.mdx index 54ff4aa625..905175022e 100644 --- a/docs/reference/replicated-cli-app-rm.mdx +++ b/docs/reference/replicated-cli-app-rm.mdx @@ -46,6 +46,7 @@ replicated app delete "Custom App" --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-app.mdx b/docs/reference/replicated-cli-app.mdx index 515f3edebf..ea70904690 100644 --- a/docs/reference/replicated-cli-app.mdx +++ b/docs/reference/replicated-cli-app.mdx @@ -49,6 +49,7 @@ replicated app ls --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-create.mdx b/docs/reference/replicated-cli-channel-create.mdx index 5b8f51f829..3f6682d38b 100644 --- a/docs/reference/replicated-cli-channel-create.mdx +++ b/docs/reference/replicated-cli-channel-create.mdx @@ -29,6 +29,7 @@ replicated channel create --name Beta --description 'New features subject to cha ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-demote.mdx b/docs/reference/replicated-cli-channel-demote.mdx index 1160fb7368..81fc60c758 100644 --- a/docs/reference/replicated-cli-channel-demote.mdx +++ b/docs/reference/replicated-cli-channel-demote.mdx @@ -32,6 +32,7 @@ replicated channel demote CHANNEL_ID_OR_NAME [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx b/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx index 5e8b8f711f..63bfb06935 100644 --- a/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx +++ b/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx @@ -26,6 +26,7 @@ replicated channel disable-semantic-versioning CHANNEL_ID ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx b/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx index c615e7962b..44a4b21747 100644 --- a/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx +++ b/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx @@ -26,6 +26,7 @@ replicated channel enable-semantic-versioning CHANNEL_ID ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-inspect.mdx b/docs/reference/replicated-cli-channel-inspect.mdx index 545210c413..8e098122d9 100644 --- a/docs/reference/replicated-cli-channel-inspect.mdx +++ b/docs/reference/replicated-cli-channel-inspect.mdx @@ -21,6 +21,7 @@ replicated channel inspect CHANNEL_ID [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-ls.mdx b/docs/reference/replicated-cli-channel-ls.mdx index 158cc21f32..06785350d5 100644 --- a/docs/reference/replicated-cli-channel-ls.mdx +++ b/docs/reference/replicated-cli-channel-ls.mdx @@ -27,6 +27,7 @@ ls, list ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-rm.mdx b/docs/reference/replicated-cli-channel-rm.mdx index 0ddabfc3ca..8b0c9c937d 100644 --- a/docs/reference/replicated-cli-channel-rm.mdx +++ b/docs/reference/replicated-cli-channel-rm.mdx @@ -26,6 +26,7 @@ rm, delete ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel-un-demote.mdx b/docs/reference/replicated-cli-channel-un-demote.mdx index 8f01ac1488..0caf3f3573 100644 --- a/docs/reference/replicated-cli-channel-un-demote.mdx +++ b/docs/reference/replicated-cli-channel-un-demote.mdx @@ -32,6 +32,7 @@ replicated channel un-demote CHANNEL_ID_OR_NAME [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-channel.mdx b/docs/reference/replicated-cli-channel.mdx index 578959147d..574f7d5307 100644 --- a/docs/reference/replicated-cli-channel.mdx +++ b/docs/reference/replicated-cli-channel.mdx @@ -16,6 +16,7 @@ List channels ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx b/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx index 0aa6963e20..cb478ae752 100644 --- a/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx +++ b/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx @@ -43,6 +43,7 @@ replicated cluster addon create object-store 05929b24 --bucket-prefix custom-pre ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-addon-create.mdx b/docs/reference/replicated-cli-cluster-addon-create.mdx index b53724514d..8a1d2231df 100644 --- a/docs/reference/replicated-cli-cluster-addon-create.mdx +++ b/docs/reference/replicated-cli-cluster-addon-create.mdx @@ -26,6 +26,7 @@ replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-addon-ls.mdx b/docs/reference/replicated-cli-cluster-addon-ls.mdx index c783aa968a..6bb343b11d 100644 --- a/docs/reference/replicated-cli-cluster-addon-ls.mdx +++ b/docs/reference/replicated-cli-cluster-addon-ls.mdx @@ -42,6 +42,7 @@ replicated cluster addon ls CLUSTER_ID --output wide ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-addon-rm.mdx b/docs/reference/replicated-cli-cluster-addon-rm.mdx index aa70118cb5..1a7dc9ef99 100644 --- a/docs/reference/replicated-cli-cluster-addon-rm.mdx +++ b/docs/reference/replicated-cli-cluster-addon-rm.mdx @@ -36,6 +36,7 @@ replicated cluster addon rm cluster456 --id abc123 ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-addon.mdx b/docs/reference/replicated-cli-cluster-addon.mdx index 23f033232d..805b45008c 100644 --- a/docs/reference/replicated-cli-cluster-addon.mdx +++ b/docs/reference/replicated-cli-cluster-addon.mdx @@ -34,6 +34,7 @@ replicated cluster addon ls CLUSTER_ID --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-create.mdx b/docs/reference/replicated-cli-cluster-create.mdx index b6efdfd2c6..63027ce300 100644 --- 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) - --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) (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) @@ -70,6 +70,7 @@ replicated cluster create --distribution eks --version 1.21 --nodes 3 --addon ob ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-kubeconfig.mdx b/docs/reference/replicated-cli-cluster-kubeconfig.mdx index 45449fba2e..7a1650c1f0 100644 --- a/docs/reference/replicated-cli-cluster-kubeconfig.mdx +++ b/docs/reference/replicated-cli-cluster-kubeconfig.mdx @@ -47,6 +47,7 @@ replicated cluster kubeconfig --id CLUSTER_ID ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-ls.mdx b/docs/reference/replicated-cli-cluster-ls.mdx index fcf66d8886..189b562514 100644 --- 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 - --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) (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 @@ -57,6 +57,7 @@ replicated cluster ls --output wide ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx index 48be3f0161..ab034d171d 100644 --- a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx +++ b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx @@ -37,13 +37,14 @@ replicated cluster nodegroup 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) (default "table") ``` ### 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 ``` diff --git a/docs/reference/replicated-cli-cluster-nodegroup.mdx b/docs/reference/replicated-cli-cluster-nodegroup.mdx index d8d3da31a3..cb2aaea0a9 100644 --- a/docs/reference/replicated-cli-cluster-nodegroup.mdx +++ b/docs/reference/replicated-cli-cluster-nodegroup.mdx @@ -25,6 +25,7 @@ replicated cluster nodegroup ls CLUSTER_ID ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-port-expose.mdx b/docs/reference/replicated-cli-cluster-port-expose.mdx index c88c6e9050..c5b5902dd8 100644 --- 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 - --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) (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 @@ -46,6 +46,7 @@ replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --output ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-port-ls.mdx b/docs/reference/replicated-cli-cluster-port-ls.mdx index 2216e6df41..4dbf3c33e9 100644 --- a/docs/reference/replicated-cli-cluster-port-ls.mdx +++ b/docs/reference/replicated-cli-cluster-port-ls.mdx @@ -35,13 +35,14 @@ replicated cluster port 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) (default "table") ``` ### 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 ``` diff --git a/docs/reference/replicated-cli-cluster-port-rm.mdx b/docs/reference/replicated-cli-cluster-port-rm.mdx index d312cd7039..e7d2520486 100644 --- a/docs/reference/replicated-cli-cluster-port-rm.mdx +++ b/docs/reference/replicated-cli-cluster-port-rm.mdx @@ -38,13 +38,14 @@ 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) - --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) (default "table") ``` ### 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 ``` diff --git a/docs/reference/replicated-cli-cluster-port.mdx b/docs/reference/replicated-cli-cluster-port.mdx index 90e1946d0c..430aa09722 100644 --- a/docs/reference/replicated-cli-cluster-port.mdx +++ b/docs/reference/replicated-cli-cluster-port.mdx @@ -31,6 +31,7 @@ replicated cluster port expose [CLUSTER_ID] [PORT] ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-prepare.mdx b/docs/reference/replicated-cli-cluster-prepare.mdx index 31ee8b84e5..04180d962c 100644 --- a/docs/reference/replicated-cli-cluster-prepare.mdx +++ b/docs/reference/replicated-cli-cluster-prepare.mdx @@ -60,6 +60,7 @@ replicated cluster prepare --distribution eks --version 1.27 --instance-type c6. ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-rm.mdx b/docs/reference/replicated-cli-cluster-rm.mdx index 603cda82d6..f2d493ca17 100644 --- a/docs/reference/replicated-cli-cluster-rm.mdx +++ b/docs/reference/replicated-cli-cluster-rm.mdx @@ -46,6 +46,7 @@ replicated cluster rm --all ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-shell.mdx b/docs/reference/replicated-cli-cluster-shell.mdx index d9cf2db027..6c59eb579b 100644 --- a/docs/reference/replicated-cli-cluster-shell.mdx +++ b/docs/reference/replicated-cli-cluster-shell.mdx @@ -36,6 +36,7 @@ replicated cluster shell --name "My Cluster" ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-update-nodegroup.mdx b/docs/reference/replicated-cli-cluster-update-nodegroup.mdx index d6f4f3aca6..5304f0561a 100644 --- a/docs/reference/replicated-cli-cluster-update-nodegroup.mdx +++ b/docs/reference/replicated-cli-cluster-update-nodegroup.mdx @@ -31,13 +31,14 @@ 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 - --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) (default "table") ``` ### Options inherited from parent commands ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --id string id of the cluster to update (when name is not provided) --name string Name of the cluster to update. --token string The API token to use to access your app in the Vendor API diff --git a/docs/reference/replicated-cli-cluster-update-ttl.mdx b/docs/reference/replicated-cli-cluster-update-ttl.mdx index 5805166e1d..31c9124257 100644 --- 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 - --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) (default "table") --ttl string Update TTL which starts from the moment the cluster is running (duration, max 48h). ``` @@ -29,6 +29,7 @@ replicated cluster update ttl CLUSTER_ID --ttl 24h ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --id string id of the cluster to update (when name is not provided) --name string Name of the cluster to update. --token string The API token to use to access your app in the Vendor API diff --git a/docs/reference/replicated-cli-cluster-update.mdx b/docs/reference/replicated-cli-cluster-update.mdx index fabe515263..1fe5c2396e 100644 --- a/docs/reference/replicated-cli-cluster-update.mdx +++ b/docs/reference/replicated-cli-cluster-update.mdx @@ -30,6 +30,7 @@ replicated cluster update --name [subcommand] ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-upgrade.mdx b/docs/reference/replicated-cli-cluster-upgrade.mdx index fad71db1ad..e433a171e1 100644 --- 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 - --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) (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) ``` @@ -37,6 +37,7 @@ replicated cluster upgrade [CLUSTER_ID] --version 1.31 --wait 30m ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster-versions.mdx b/docs/reference/replicated-cli-cluster-versions.mdx index 04d58f85d6..e741458f62 100644 --- a/docs/reference/replicated-cli-cluster-versions.mdx +++ b/docs/reference/replicated-cli-cluster-versions.mdx @@ -35,6 +35,7 @@ replicated cluster versions --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-cluster.mdx b/docs/reference/replicated-cli-cluster.mdx index fd120e2ea2..41ffa5cd27 100644 --- a/docs/reference/replicated-cli-cluster.mdx +++ b/docs/reference/replicated-cli-cluster.mdx @@ -32,6 +32,7 @@ replicated cluster nodegroup ls ``` --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 ``` diff --git a/docs/reference/replicated-cli-completion.mdx b/docs/reference/replicated-cli-completion.mdx index 647ed35347..02742c3fe1 100644 --- a/docs/reference/replicated-cli-completion.mdx +++ b/docs/reference/replicated-cli-completion.mdx @@ -63,6 +63,7 @@ PowerShell: ``` --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 ``` diff --git a/docs/reference/replicated-cli-customer-archive.mdx b/docs/reference/replicated-cli-customer-archive.mdx index 95b70b107c..41c977df8d 100644 --- a/docs/reference/replicated-cli-customer-archive.mdx +++ b/docs/reference/replicated-cli-customer-archive.mdx @@ -42,6 +42,7 @@ replicated customer archive --app myapp "Acme Inc" ### Options inherited from parent commands ``` + --debug Enable debug output --token string The API token to use to access your app in the Vendor API ``` diff --git a/docs/reference/replicated-cli-customer-create.mdx b/docs/reference/replicated-cli-customer-create.mdx index 6b2588686c..7d6596ec4e 100644 --- a/docs/reference/replicated-cli-customer-create.mdx +++ b/docs/reference/replicated-cli-customer-create.mdx @@ -71,6 +71,7 @@ replicated customer create --app myapp --name "Full Options Inc" --custom-id "FU ``` --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 ``` diff --git a/docs/reference/replicated-cli-customer-download-license.mdx b/docs/reference/replicated-cli-customer-download-license.mdx index 4b3d5c3c5c..b94d8e4680 100644 --- a/docs/reference/replicated-cli-customer-download-license.mdx +++ b/docs/reference/replicated-cli-customer-download-license.mdx @@ -41,6 +41,7 @@ replicated customer download-license --app myapp --customer "Acme Inc" --output ``` --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 ``` diff --git a/docs/reference/replicated-cli-customer-inspect.mdx b/docs/reference/replicated-cli-customer-inspect.mdx index e918fb8204..be4887b3d6 100644 --- a/docs/reference/replicated-cli-customer-inspect.mdx +++ b/docs/reference/replicated-cli-customer-inspect.mdx @@ -44,6 +44,7 @@ replicated customer inspect --app myapp --customer "Acme Inc" ``` --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 ``` diff --git a/docs/reference/replicated-cli-customer-ls.mdx b/docs/reference/replicated-cli-customer-ls.mdx index 038429aa5c..61c4c4cbf1 100644 --- a/docs/reference/replicated-cli-customer-ls.mdx +++ b/docs/reference/replicated-cli-customer-ls.mdx @@ -49,6 +49,7 @@ replicated customer ls --app myapp --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-customer-update.mdx b/docs/reference/replicated-cli-customer-update.mdx index 01f928f123..2774416b08 100644 --- a/docs/reference/replicated-cli-customer-update.mdx +++ b/docs/reference/replicated-cli-customer-update.mdx @@ -70,6 +70,7 @@ replicated customer update --customer cus_abcdef123456 --name "JSON Corp" --outp ``` --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 ``` diff --git a/docs/reference/replicated-cli-customer.mdx b/docs/reference/replicated-cli-customer.mdx index 21ee579379..f79228f769 100644 --- a/docs/reference/replicated-cli-customer.mdx +++ b/docs/reference/replicated-cli-customer.mdx @@ -16,6 +16,7 @@ The customers command allows vendors to create, display, modify end customer rec ``` --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 ``` diff --git a/docs/reference/replicated-cli-default-clear-all.mdx b/docs/reference/replicated-cli-default-clear-all.mdx index 730071c3bf..baeea8174b 100644 --- a/docs/reference/replicated-cli-default-clear-all.mdx +++ b/docs/reference/replicated-cli-default-clear-all.mdx @@ -29,6 +29,7 @@ replicated default clear-all ``` --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 ``` diff --git a/docs/reference/replicated-cli-default-clear.mdx b/docs/reference/replicated-cli-default-clear.mdx index a30ce0d673..409fbac9bb 100644 --- a/docs/reference/replicated-cli-default-clear.mdx +++ b/docs/reference/replicated-cli-default-clear.mdx @@ -32,6 +32,7 @@ replicated default clear app ``` --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 ``` diff --git a/docs/reference/replicated-cli-default-set.mdx b/docs/reference/replicated-cli-default-set.mdx index df918af00a..c9b3dbc337 100644 --- a/docs/reference/replicated-cli-default-set.mdx +++ b/docs/reference/replicated-cli-default-set.mdx @@ -36,6 +36,7 @@ replicated default set app my-app-slug ``` --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 ``` diff --git a/docs/reference/replicated-cli-default-show.mdx b/docs/reference/replicated-cli-default-show.mdx index 3d96c9b24c..84c803d4bf 100644 --- a/docs/reference/replicated-cli-default-show.mdx +++ b/docs/reference/replicated-cli-default-show.mdx @@ -37,6 +37,7 @@ replicated default show app ``` --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 ``` diff --git a/docs/reference/replicated-cli-default.mdx b/docs/reference/replicated-cli-default.mdx index 09cd615cfe..df39875418 100644 --- a/docs/reference/replicated-cli-default.mdx +++ b/docs/reference/replicated-cli-default.mdx @@ -12,6 +12,7 @@ Manage default values used by other 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 ``` diff --git a/docs/reference/replicated-cli-installer-create.mdx b/docs/reference/replicated-cli-installer-create.mdx index 46714a5649..8cb54d2a15 100644 --- a/docs/reference/replicated-cli-installer-create.mdx +++ b/docs/reference/replicated-cli-installer-create.mdx @@ -17,7 +17,7 @@ replicated installer create [flags] -y, --confirm-auto auto-accept the configuration generated by the --auto flag --ensure-channel When used with --promote , will create the channel if it doesn't exist -h, --help help for create - --promote string Channel name or id to promote this installer to + --promote string Channel name (case sensitive) or id to promote this installer to --yaml string The YAML config for this installer. Use '-' to read from stdin. Cannot be used with the --yaml-file flag. --yaml-file string The file name with YAML config for this installer. Cannot be used with the --yaml flag. ``` @@ -26,6 +26,7 @@ replicated installer create [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-installer-ls.mdx b/docs/reference/replicated-cli-installer-ls.mdx index 29751182fc..cfed01d57a 100644 --- a/docs/reference/replicated-cli-installer-ls.mdx +++ b/docs/reference/replicated-cli-installer-ls.mdx @@ -27,6 +27,7 @@ ls, list ``` --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 ``` diff --git a/docs/reference/replicated-cli-installer.mdx b/docs/reference/replicated-cli-installer.mdx index 0d5f041026..a11abe2d95 100644 --- a/docs/reference/replicated-cli-installer.mdx +++ b/docs/reference/replicated-cli-installer.mdx @@ -16,6 +16,7 @@ The installers command allows vendors to create, display, modify and promote kur ``` --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 ``` diff --git a/docs/reference/replicated-cli-instance-inspect.mdx b/docs/reference/replicated-cli-instance-inspect.mdx index 933596ef0a..d1991729be 100644 --- a/docs/reference/replicated-cli-instance-inspect.mdx +++ b/docs/reference/replicated-cli-instance-inspect.mdx @@ -23,6 +23,7 @@ replicated instance inspect [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-instance-ls.mdx b/docs/reference/replicated-cli-instance-ls.mdx index adfb98a73b..9b0c5f7e04 100644 --- a/docs/reference/replicated-cli-instance-ls.mdx +++ b/docs/reference/replicated-cli-instance-ls.mdx @@ -29,6 +29,7 @@ ls, list ``` --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 ``` diff --git a/docs/reference/replicated-cli-instance-tag.mdx b/docs/reference/replicated-cli-instance-tag.mdx index ab0c54a5dc..a752c43e9d 100644 --- a/docs/reference/replicated-cli-instance-tag.mdx +++ b/docs/reference/replicated-cli-instance-tag.mdx @@ -24,6 +24,7 @@ replicated instance tag [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-instance.mdx b/docs/reference/replicated-cli-instance.mdx index 65c8703577..4dea77ceaf 100644 --- a/docs/reference/replicated-cli-instance.mdx +++ b/docs/reference/replicated-cli-instance.mdx @@ -16,6 +16,7 @@ The instance command allows vendors to display and tag customer instances. ``` --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 ``` diff --git a/docs/reference/replicated-cli-login.mdx b/docs/reference/replicated-cli-login.mdx index 3590eee319..a1e9c643ad 100644 --- a/docs/reference/replicated-cli-login.mdx +++ b/docs/reference/replicated-cli-login.mdx @@ -20,6 +20,7 @@ replicated login [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-logout.mdx b/docs/reference/replicated-cli-logout.mdx index 6e82fb2e72..15d700b6c0 100644 --- a/docs/reference/replicated-cli-logout.mdx +++ b/docs/reference/replicated-cli-logout.mdx @@ -20,6 +20,7 @@ replicated logout [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-registry-add-dockerhub.mdx b/docs/reference/replicated-cli-registry-add-dockerhub.mdx index 20f986ca50..ca29b6b3e7 100644 --- a/docs/reference/replicated-cli-registry-add-dockerhub.mdx +++ b/docs/reference/replicated-cli-registry-add-dockerhub.mdx @@ -27,6 +27,7 @@ replicated registry add dockerhub [flags] ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --skip-validation Skip validation of the registry (not recommended) ``` diff --git a/docs/reference/replicated-cli-registry-add-ecr.mdx b/docs/reference/replicated-cli-registry-add-ecr.mdx index 7ed452ec48..f89bada913 100644 --- a/docs/reference/replicated-cli-registry-add-ecr.mdx +++ b/docs/reference/replicated-cli-registry-add-ecr.mdx @@ -25,6 +25,7 @@ replicated registry add ecr [flags] ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --skip-validation Skip validation of the registry (not recommended) --token string The API token to use to access your app in the Vendor API ``` diff --git a/docs/reference/replicated-cli-registry-add-gar.mdx b/docs/reference/replicated-cli-registry-add-gar.mdx index 41488a316c..577c9e8ad4 100644 --- a/docs/reference/replicated-cli-registry-add-gar.mdx +++ b/docs/reference/replicated-cli-registry-add-gar.mdx @@ -27,6 +27,7 @@ replicated registry add gar [flags] ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --skip-validation Skip validation of the registry (not recommended) ``` diff --git a/docs/reference/replicated-cli-registry-add-gcr.mdx b/docs/reference/replicated-cli-registry-add-gcr.mdx index 194a95088d..891968c2e7 100644 --- a/docs/reference/replicated-cli-registry-add-gcr.mdx +++ b/docs/reference/replicated-cli-registry-add-gcr.mdx @@ -24,6 +24,7 @@ replicated registry add gcr [flags] ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --skip-validation Skip validation of the registry (not recommended) --token string The API token to use to access your app in the Vendor API ``` diff --git a/docs/reference/replicated-cli-registry-add-ghcr.mdx b/docs/reference/replicated-cli-registry-add-ghcr.mdx index 430712bdca..c92f6ddf70 100644 --- a/docs/reference/replicated-cli-registry-add-ghcr.mdx +++ b/docs/reference/replicated-cli-registry-add-ghcr.mdx @@ -23,6 +23,7 @@ replicated registry add ghcr [flags] ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --skip-validation Skip validation of the registry (not recommended) ``` diff --git a/docs/reference/replicated-cli-registry-add-other.mdx b/docs/reference/replicated-cli-registry-add-other.mdx index 087feba3b3..4ff7182a34 100644 --- a/docs/reference/replicated-cli-registry-add-other.mdx +++ b/docs/reference/replicated-cli-registry-add-other.mdx @@ -25,6 +25,7 @@ replicated registry add other [flags] ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --skip-validation Skip validation of the registry (not recommended) --token string The API token to use to access your app in the Vendor API ``` diff --git a/docs/reference/replicated-cli-registry-add-quay.mdx b/docs/reference/replicated-cli-registry-add-quay.mdx index 41ff91ff9c..da8c2ac5e0 100644 --- a/docs/reference/replicated-cli-registry-add-quay.mdx +++ b/docs/reference/replicated-cli-registry-add-quay.mdx @@ -24,6 +24,7 @@ replicated registry add quay [flags] ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --skip-validation Skip validation of the registry (not recommended) --token string The API token to use to access your app in the Vendor API ``` diff --git a/docs/reference/replicated-cli-registry-add.mdx b/docs/reference/replicated-cli-registry-add.mdx index 5a65ce2a88..2273232957 100644 --- a/docs/reference/replicated-cli-registry-add.mdx +++ b/docs/reference/replicated-cli-registry-add.mdx @@ -17,6 +17,7 @@ add ``` --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 ``` diff --git a/docs/reference/replicated-cli-registry-ls.mdx b/docs/reference/replicated-cli-registry-ls.mdx index cc453bf024..9f862ce7ce 100644 --- a/docs/reference/replicated-cli-registry-ls.mdx +++ b/docs/reference/replicated-cli-registry-ls.mdx @@ -27,6 +27,7 @@ ls, list ``` --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 ``` diff --git a/docs/reference/replicated-cli-registry-rm.mdx b/docs/reference/replicated-cli-registry-rm.mdx index eba542695f..87ae62cba3 100644 --- a/docs/reference/replicated-cli-registry-rm.mdx +++ b/docs/reference/replicated-cli-registry-rm.mdx @@ -26,6 +26,7 @@ rm, delete ``` --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 ``` diff --git a/docs/reference/replicated-cli-registry-test.mdx b/docs/reference/replicated-cli-registry-test.mdx index e0c4a5948b..34b26db7e5 100644 --- a/docs/reference/replicated-cli-registry-test.mdx +++ b/docs/reference/replicated-cli-registry-test.mdx @@ -21,6 +21,7 @@ replicated registry test HOSTNAME [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-registry.mdx b/docs/reference/replicated-cli-registry.mdx index 4826655a7a..5348536ab6 100644 --- a/docs/reference/replicated-cli-registry.mdx +++ b/docs/reference/replicated-cli-registry.mdx @@ -16,6 +16,7 @@ registry can be used to manage existing registries and add new registries to a t ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-compatibility.mdx b/docs/reference/replicated-cli-release-compatibility.mdx index 7341813476..a9b815bf5a 100644 --- a/docs/reference/replicated-cli-release-compatibility.mdx +++ b/docs/reference/replicated-cli-release-compatibility.mdx @@ -25,6 +25,7 @@ replicated release compatibility SEQUENCE [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-create.mdx b/docs/reference/replicated-cli-release-create.mdx index a8d090a643..c6b17d93f8 100644 --- a/docs/reference/replicated-cli-release-create.mdx +++ b/docs/reference/replicated-cli-release-create.mdx @@ -20,7 +20,7 @@ replicated release create [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 create --lint Lint a manifests directory prior to creation of the KOTS Release. - --promote string Channel name or id to promote this release to + --promote string Channel name (case sensitive) or id to promote this release to --release-notes string When used with --promote , sets the **markdown** release notes --version string When used with --promote , sets the version label for the release in this channel --yaml-dir string The directory containing multiple yamls for a Kots release. Cannot be used with the --yaml flag. @@ -30,6 +30,7 @@ replicated release create [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-download.mdx b/docs/reference/replicated-cli-release-download.mdx index c92c6586e5..36e1c28715 100644 --- a/docs/reference/replicated-cli-release-download.mdx +++ b/docs/reference/replicated-cli-release-download.mdx @@ -29,6 +29,7 @@ replicated release download 1 --dest ./manifests ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-inspect.mdx b/docs/reference/replicated-cli-release-inspect.mdx index a8e2f0b141..f8eb13a918 100644 --- a/docs/reference/replicated-cli-release-inspect.mdx +++ b/docs/reference/replicated-cli-release-inspect.mdx @@ -37,6 +37,7 @@ replicated release inspect 123 --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-lint.mdx b/docs/reference/replicated-cli-release-lint.mdx index f15556f0ed..bb726b527c 100644 --- a/docs/reference/replicated-cli-release-lint.mdx +++ b/docs/reference/replicated-cli-release-lint.mdx @@ -23,6 +23,7 @@ replicated release lint [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-ls.mdx b/docs/reference/replicated-cli-release-ls.mdx index fa11ad4d92..f3abff1062 100644 --- a/docs/reference/replicated-cli-release-ls.mdx +++ b/docs/reference/replicated-cli-release-ls.mdx @@ -27,6 +27,7 @@ ls, list ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-promote.mdx b/docs/reference/replicated-cli-release-promote.mdx index 3af06d075f..c8e50800cd 100644 --- a/docs/reference/replicated-cli-release-promote.mdx +++ b/docs/reference/replicated-cli-release-promote.mdx @@ -30,6 +30,7 @@ replicated release promote 15 fe4901690971757689f022f7a460f9b2 ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-test.mdx b/docs/reference/replicated-cli-release-test.mdx index e0d46d436b..ac5ef228c8 100644 --- a/docs/reference/replicated-cli-release-test.mdx +++ b/docs/reference/replicated-cli-release-test.mdx @@ -20,6 +20,7 @@ replicated release test SEQUENCE [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-release-update.mdx b/docs/reference/replicated-cli-release-update.mdx index 35ffc2cae2..b23909ade4 100644 --- a/docs/reference/replicated-cli-release-update.mdx +++ b/docs/reference/replicated-cli-release-update.mdx @@ -23,6 +23,7 @@ replicated release update SEQUENCE [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-release.mdx b/docs/reference/replicated-cli-release.mdx index 68e4323ba1..b5c2fc8ffe 100644 --- a/docs/reference/replicated-cli-release.mdx +++ b/docs/reference/replicated-cli-release.mdx @@ -16,6 +16,7 @@ The release command allows vendors to create, display, and promote their release ``` --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 ``` diff --git a/docs/reference/replicated-cli-version-upgrade.mdx b/docs/reference/replicated-cli-version-upgrade.mdx index 0c3d93c3c7..162a60d9c5 100644 --- a/docs/reference/replicated-cli-version-upgrade.mdx +++ b/docs/reference/replicated-cli-version-upgrade.mdx @@ -20,6 +20,7 @@ replicated version upgrade [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-version.mdx b/docs/reference/replicated-cli-version.mdx index 0258ca4a9b..71c532add2 100644 --- a/docs/reference/replicated-cli-version.mdx +++ b/docs/reference/replicated-cli-version.mdx @@ -21,6 +21,7 @@ replicated version [flags] ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm-create.mdx b/docs/reference/replicated-cli-vm-create.mdx index c227299a2c..8012239beb 100644 --- a/docs/reference/replicated-cli-vm-create.mdx +++ b/docs/reference/replicated-cli-vm-create.mdx @@ -40,7 +40,7 @@ replicated vm create --distribution ubuntu --version 20.04 --count 5 --instance- --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 - --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) (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 Vversion to provision (format is distribution dependent) @@ -51,6 +51,7 @@ replicated vm create --distribution ubuntu --version 20.04 --count 5 --instance- ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm-ls.mdx b/docs/reference/replicated-cli-vm-ls.mdx index 71a29819bc..ddfd51265c 100644 --- a/docs/reference/replicated-cli-vm-ls.mdx +++ b/docs/reference/replicated-cli-vm-ls.mdx @@ -43,7 +43,7 @@ replicated vm ls --watch ``` --end-time string end time for the query (Format: 2006-01-02T15:04:05Z) -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) (default "table") --show-terminated when set, only show terminated vms --start-time string start time for the query (Format: 2006-01-02T15:04:05Z) -w, --watch watch vms @@ -53,6 +53,7 @@ replicated vm ls --watch ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm-port-expose.mdx b/docs/reference/replicated-cli-vm-port-expose.mdx index 2413a78ce7..2a31f91a47 100644 --- a/docs/reference/replicated-cli-vm-port-expose.mdx +++ b/docs/reference/replicated-cli-vm-port-expose.mdx @@ -34,7 +34,7 @@ replicated vm port expose VM_ID --port 8080 --protocol https --output json ``` -h, --help help for expose - --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) (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 @@ -44,6 +44,7 @@ replicated vm port expose VM_ID --port 8080 --protocol https --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm-port-ls.mdx b/docs/reference/replicated-cli-vm-port-ls.mdx index dad31f8710..602d79f761 100644 --- a/docs/reference/replicated-cli-vm-port-ls.mdx +++ b/docs/reference/replicated-cli-vm-port-ls.mdx @@ -29,13 +29,14 @@ replicated vm port ls VM_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) (default "table") ``` ### 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 ``` diff --git a/docs/reference/replicated-cli-vm-port-rm.mdx b/docs/reference/replicated-cli-vm-port-rm.mdx index 751fade504..4f10737f63 100644 --- a/docs/reference/replicated-cli-vm-port-rm.mdx +++ b/docs/reference/replicated-cli-vm-port-rm.mdx @@ -27,13 +27,14 @@ replicated vm port rm VM_ID --id PORT_ID --output json ``` -h, --help help for rm --id string ID of the port to remove (required) - --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) (default "table") ``` ### 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 ``` diff --git a/docs/reference/replicated-cli-vm-port.mdx b/docs/reference/replicated-cli-vm-port.mdx index e40d1110ac..c04c39821c 100644 --- a/docs/reference/replicated-cli-vm-port.mdx +++ b/docs/reference/replicated-cli-vm-port.mdx @@ -31,6 +31,7 @@ replicated vm port expose [VM_ID] [PORT] ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm-rm.mdx b/docs/reference/replicated-cli-vm-rm.mdx index 3ef7ad903d..44290a5a16 100644 --- a/docs/reference/replicated-cli-vm-rm.mdx +++ b/docs/reference/replicated-cli-vm-rm.mdx @@ -56,6 +56,7 @@ replicated vm rm --all --dry-run ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm-scp.mdx b/docs/reference/replicated-cli-vm-scp.mdx new file mode 100644 index 0000000000..0215869c92 --- /dev/null +++ b/docs/reference/replicated-cli-vm-scp.mdx @@ -0,0 +1,65 @@ +# replicated vm scp + +Copy files to/from a VM + +### Synopsis + +Securely copy files to or from a VM using SCP. + +This command allows you to copy files between your local machine and a VM. You can specify the VM ID followed by a colon and the path on the VM, or just a local path. + +To copy a file from your local machine to a VM, use: +replicated vm scp localfile.txt vm-id:/path/on/vm/ + +To copy a file from a VM to your local machine, use: +replicated vm scp vm-id:/path/on/vm/file.txt localfile.txt + +If no VM ID is provided and multiple VMs are available, you will be prompted to select a VM. + +The SSH user can be specified in order of precedence: +1. By specifying the -u flag +2. REPLICATED_SSH_USER environment variable +3. GITHUB_ACTOR environment variable (from GitHub Actions) +4. GITHUB_USER environment variable + +Note: Only running VMs can be connected to via SCP. + +``` +replicated vm scp [VM_ID:]SOURCE [VM_ID:]DESTINATION [flags] +``` + +### Examples + +``` +# Copy a local file to a VM +replicated vm scp localfile.txt vm-id:/home/user/ + +# Copy a file from a VM to local machine +replicated vm scp vm-id:/home/user/file.txt localfile.txt + +# Copy with a specific user +replicated vm scp -u myuser localfile.txt vm-id:/home/myuser/ + +# Interactive VM selection (if VM ID is not specified) +replicated vm scp localfile.txt :/home/user/ +``` + +### Options + +``` + -h, --help help for scp + -u, --user string SSH user to connect with +``` + +### 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. + diff --git a/docs/reference/replicated-cli-vm-ssh.mdx b/docs/reference/replicated-cli-vm-ssh.mdx new file mode 100644 index 0000000000..d405b3cf3c --- /dev/null +++ b/docs/reference/replicated-cli-vm-ssh.mdx @@ -0,0 +1,54 @@ +# replicated vm ssh + +SSH into a VM + +### Synopsis + +Connect to a VM using SSH. + +If a VM ID is provided, it will directly connect to that VM. Otherwise, if multiple VMs are available, you will be prompted to select the VM you want to connect to. The command will then establish an SSH connection to the selected VM using the appropriate credentials and configuration. + +The SSH user can be specified in order of precedence: +1. By specifying the -u flag +2. REPLICATED_SSH_USER environment variable +3. GITHUB_ACTOR environment variable (from GitHub Actions) +4. GITHUB_USER environment variable + +Note: Only running VMs can be connected to via SSH. + +``` +replicated vm ssh [VM_ID] [flags] +``` + +### Examples + +``` +# SSH into a specific VM by ID +replicated vm ssh + +# SSH into a VM with a specific user +replicated vm ssh -u myuser + +# SSH into a VM (interactive selection if multiple VMs exist) +replicated vm ssh +``` + +### Options + +``` + -h, --help help for ssh + -u, --user string SSH user to connect with +``` + +### 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. + diff --git a/docs/reference/replicated-cli-vm-update-ttl.mdx b/docs/reference/replicated-cli-vm-update-ttl.mdx index a50ac425c9..b4571e5352 100644 --- a/docs/reference/replicated-cli-vm-update-ttl.mdx +++ b/docs/reference/replicated-cli-vm-update-ttl.mdx @@ -30,7 +30,7 @@ replicated vm update ttl aaaaa11 --ttl 30m ``` -h, --help help for ttl - --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) (default "table") --ttl string Update TTL which starts from the moment the vm is running (duration, max 48h). ``` @@ -38,6 +38,7 @@ replicated vm update ttl aaaaa11 --ttl 30m ``` --app string The app slug or app id to use in all calls + --debug Enable debug output --id string id of the vm to update (when name is not provided) --name string Name of the vm to update. --token string The API token to use to access your app in the Vendor API diff --git a/docs/reference/replicated-cli-vm-update.mdx b/docs/reference/replicated-cli-vm-update.mdx index e7c102730d..7b20b663c4 100644 --- a/docs/reference/replicated-cli-vm-update.mdx +++ b/docs/reference/replicated-cli-vm-update.mdx @@ -33,6 +33,7 @@ replicated vm update --name --ttl 12h ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm-versions.mdx b/docs/reference/replicated-cli-vm-versions.mdx index 1cf99cb108..4ed199acf7 100644 --- a/docs/reference/replicated-cli-vm-versions.mdx +++ b/docs/reference/replicated-cli-vm-versions.mdx @@ -38,6 +38,7 @@ replicated vm versions --output json ``` --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 ``` diff --git a/docs/reference/replicated-cli-vm.mdx b/docs/reference/replicated-cli-vm.mdx index 02c2f25a30..6d0b6cb93c 100644 --- a/docs/reference/replicated-cli-vm.mdx +++ b/docs/reference/replicated-cli-vm.mdx @@ -32,6 +32,7 @@ replicated vm update ttl --ttl 24h ``` --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 ``` @@ -42,6 +43,8 @@ replicated vm update ttl --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](replicated-cli-vm-scp) - Copy files to/from a VM +* [replicated vm ssh](replicated-cli-vm-ssh) - SSH into a VM * [replicated vm update](replicated-cli-vm-update) - Update VM settings. * [replicated vm versions](replicated-cli-vm-versions) - List available VM versions. diff --git a/docs/reference/replicated.mdx b/docs/reference/replicated.mdx index 8881017d67..f30b4c1c42 100644 --- a/docs/reference/replicated.mdx +++ b/docs/reference/replicated.mdx @@ -10,6 +10,7 @@ The 'replicated' CLI allows Replicated customers (vendors) to manage their Comme ``` --app string The app slug or app id to use in all calls + --debug Enable debug output -h, --help help for replicated --token string The API token to use to access your app in the Vendor API ``` diff --git a/sidebars.js b/sidebars.js index 28623857a0..21a7236881 100644 --- a/sidebars.js +++ b/sidebars.js @@ -721,6 +721,8 @@ const sidebars = { 'reference/replicated-cli-vm-port-ls', 'reference/replicated-cli-vm-port-rm', 'reference/replicated-cli-vm-rm', + 'reference/replicated-cli-vm-scp', + 'reference/replicated-cli-vm-ssh', 'reference/replicated-cli-vm-update', 'reference/replicated-cli-vm-update-ttl', 'reference/replicated-cli-vm-versions',