From 6d71ddcf2b8427d3405b5e2b0d521d0bb5fef8fc Mon Sep 17 00:00:00 2001 From: Replicated Release Pipeline Date: Tue, 11 Nov 2025 18:50:37 +0000 Subject: [PATCH] Update Replicated CLI docs for v0.120.0 --- docs/reference/replicated-cli-api-get.mdx | 7 +- docs/reference/replicated-cli-api-patch.mdx | 7 +- docs/reference/replicated-cli-api-post.mdx | 7 +- docs/reference/replicated-cli-api-put.mdx | 7 +- docs/reference/replicated-cli-api.mdx | 7 +- docs/reference/replicated-cli-app-create.mdx | 7 +- docs/reference/replicated-cli-app-ls.mdx | 7 +- docs/reference/replicated-cli-app-rm.mdx | 7 +- docs/reference/replicated-cli-app.mdx | 7 +- .../replicated-cli-channel-create.mdx | 7 +- .../replicated-cli-channel-demote.mdx | 7 +- ...li-channel-disable-semantic-versioning.mdx | 7 +- ...cli-channel-enable-semantic-versioning.mdx | 7 +- .../replicated-cli-channel-inspect.mdx | 7 +- docs/reference/replicated-cli-channel-ls.mdx | 7 +- docs/reference/replicated-cli-channel-rm.mdx | 7 +- .../replicated-cli-channel-un-demote.mdx | 7 +- docs/reference/replicated-cli-channel.mdx | 7 +- ...-cli-cluster-addon-create-object-store.mdx | 7 +- .../replicated-cli-cluster-addon-create.mdx | 7 +- .../replicated-cli-cluster-addon-ls.mdx | 7 +- .../replicated-cli-cluster-addon-rm.mdx | 7 +- .../replicated-cli-cluster-addon.mdx | 7 +- .../replicated-cli-cluster-create.mdx | 7 +- .../replicated-cli-cluster-kubeconfig.mdx | 7 +- docs/reference/replicated-cli-cluster-ls.mdx | 7 +- .../replicated-cli-cluster-nodegroup-ls.mdx | 7 +- .../replicated-cli-cluster-nodegroup.mdx | 7 +- .../replicated-cli-cluster-port-expose.mdx | 7 +- .../replicated-cli-cluster-port-ls.mdx | 7 +- .../replicated-cli-cluster-port-rm.mdx | 7 +- .../reference/replicated-cli-cluster-port.mdx | 7 +- .../replicated-cli-cluster-prepare.mdx | 7 +- docs/reference/replicated-cli-cluster-rm.mdx | 7 +- .../replicated-cli-cluster-shell.mdx | 7 +- ...eplicated-cli-cluster-update-nodegroup.mdx | 11 +-- .../replicated-cli-cluster-update-ttl.mdx | 11 +-- .../replicated-cli-cluster-update.mdx | 7 +- .../replicated-cli-cluster-upgrade.mdx | 7 +- .../replicated-cli-cluster-versions.mdx | 7 +- docs/reference/replicated-cli-cluster.mdx | 7 +- docs/reference/replicated-cli-completion.mdx | 7 +- docs/reference/replicated-cli-config-init.mdx | 51 ++++++++++++ docs/reference/replicated-cli-config.mdx | 28 +++++++ .../replicated-cli-customer-archive.mdx | 5 +- .../replicated-cli-customer-create.mdx | 7 +- ...plicated-cli-customer-download-license.mdx | 7 +- .../replicated-cli-customer-inspect.mdx | 7 +- docs/reference/replicated-cli-customer-ls.mdx | 7 +- .../replicated-cli-customer-update.mdx | 7 +- docs/reference/replicated-cli-customer.mdx | 7 +- .../replicated-cli-default-clear-all.mdx | 7 +- .../replicated-cli-default-clear.mdx | 7 +- docs/reference/replicated-cli-default-set.mdx | 7 +- .../reference/replicated-cli-default-show.mdx | 7 +- docs/reference/replicated-cli-default.mdx | 7 +- .../replicated-cli-installer-create.mdx | 7 +- .../reference/replicated-cli-installer-ls.mdx | 7 +- docs/reference/replicated-cli-installer.mdx | 7 +- .../replicated-cli-instance-inspect.mdx | 7 +- docs/reference/replicated-cli-instance-ls.mdx | 7 +- .../reference/replicated-cli-instance-tag.mdx | 7 +- docs/reference/replicated-cli-instance.mdx | 7 +- docs/reference/replicated-cli-login.mdx | 7 +- docs/reference/replicated-cli-logout.mdx | 7 +- docs/reference/replicated-cli-network-ls.mdx | 9 ++- .../replicated-cli-network-report.mdx | 49 ------------ .../replicated-cli-network-update.mdx | 43 +++++++---- docs/reference/replicated-cli-network.mdx | 11 +-- docs/reference/replicated-cli-profile-add.mdx | 56 ++++++++++++++ .../reference/replicated-cli-profile-edit.mdx | 55 +++++++++++++ docs/reference/replicated-cli-profile-ls.mdx | 40 ++++++++++ docs/reference/replicated-cli-profile-rm.mdx | 41 ++++++++++ .../replicated-cli-profile-set-default.mdx | 39 ++++++++++ docs/reference/replicated-cli-profile-use.mdx | 39 ++++++++++ docs/reference/replicated-cli-profile.mdx | 77 +++++++++++++++++++ .../replicated-cli-registry-add-dockerhub.mdx | 1 + .../replicated-cli-registry-add-ecr.mdx | 1 + .../replicated-cli-registry-add-gar.mdx | 1 + .../replicated-cli-registry-add-gcr.mdx | 1 + .../replicated-cli-registry-add-ghcr.mdx | 1 + .../replicated-cli-registry-add-other.mdx | 1 + .../replicated-cli-registry-add-quay.mdx | 1 + .../reference/replicated-cli-registry-add.mdx | 7 +- docs/reference/replicated-cli-registry-ls.mdx | 7 +- docs/reference/replicated-cli-registry-rm.mdx | 7 +- .../replicated-cli-registry-test.mdx | 7 +- docs/reference/replicated-cli-registry.mdx | 7 +- .../replicated-cli-release-compatibility.mdx | 7 +- .../replicated-cli-release-create.mdx | 8 +- .../replicated-cli-release-download.mdx | 7 +- .../replicated-cli-release-image-ls.mdx | 7 +- .../replicated-cli-release-image.mdx | 7 +- .../replicated-cli-release-inspect.mdx | 7 +- .../reference/replicated-cli-release-lint.mdx | 14 ++-- docs/reference/replicated-cli-release-ls.mdx | 7 +- .../replicated-cli-release-promote.mdx | 7 +- .../reference/replicated-cli-release-test.mdx | 7 +- .../replicated-cli-release-update.mdx | 7 +- docs/reference/replicated-cli-release.mdx | 9 ++- .../replicated-cli-version-upgrade.mdx | 7 +- docs/reference/replicated-cli-version.mdx | 7 +- docs/reference/replicated-cli-vm-create.mdx | 7 +- docs/reference/replicated-cli-vm-ls.mdx | 7 +- .../replicated-cli-vm-port-expose.mdx | 7 +- docs/reference/replicated-cli-vm-port-ls.mdx | 7 +- docs/reference/replicated-cli-vm-port-rm.mdx | 7 +- docs/reference/replicated-cli-vm-port.mdx | 7 +- docs/reference/replicated-cli-vm-rm.mdx | 7 +- .../replicated-cli-vm-scp-endpoint.mdx | 7 +- .../replicated-cli-vm-ssh-endpoint.mdx | 7 +- .../replicated-cli-vm-update-ttl.mdx | 11 +-- docs/reference/replicated-cli-vm-update.mdx | 7 +- docs/reference/replicated-cli-vm-versions.mdx | 7 +- docs/reference/replicated-cli-vm.mdx | 7 +- docs/reference/replicated.mdx | 11 ++- sidebars.js | 12 ++- 117 files changed, 877 insertions(+), 376 deletions(-) create mode 100644 docs/reference/replicated-cli-config-init.mdx create mode 100644 docs/reference/replicated-cli-config.mdx delete mode 100644 docs/reference/replicated-cli-network-report.mdx create mode 100644 docs/reference/replicated-cli-profile-add.mdx create mode 100644 docs/reference/replicated-cli-profile-edit.mdx create mode 100644 docs/reference/replicated-cli-profile-ls.mdx create mode 100644 docs/reference/replicated-cli-profile-rm.mdx create mode 100644 docs/reference/replicated-cli-profile-set-default.mdx create mode 100644 docs/reference/replicated-cli-profile-use.mdx create mode 100644 docs/reference/replicated-cli-profile.mdx diff --git a/docs/reference/replicated-cli-api-get.mdx b/docs/reference/replicated-cli-api-get.mdx index b2e12ece36..785fa78346 100644 --- a/docs/reference/replicated-cli-api-get.mdx +++ b/docs/reference/replicated-cli-api-get.mdx @@ -30,9 +30,10 @@ replicated api get /v3/apps ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-api-patch.mdx b/docs/reference/replicated-cli-api-patch.mdx index aba1389017..c6059e8478 100644 --- a/docs/reference/replicated-cli-api-patch.mdx +++ b/docs/reference/replicated-cli-api-patch.mdx @@ -31,9 +31,10 @@ replicated api patch /v3/customer/2VffY549paATVfHSGpJhjh6Ehpy -b '{"name":"Valua ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-api-post.mdx b/docs/reference/replicated-cli-api-post.mdx index 3bfead03d9..3735c59b32 100644 --- a/docs/reference/replicated-cli-api-post.mdx +++ b/docs/reference/replicated-cli-api-post.mdx @@ -31,9 +31,10 @@ replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"mar ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-api-put.mdx b/docs/reference/replicated-cli-api-put.mdx index f2e4033196..9b9b8af9c5 100644 --- a/docs/reference/replicated-cli-api-put.mdx +++ b/docs/reference/replicated-cli-api-put.mdx @@ -31,9 +31,10 @@ replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-api.mdx b/docs/reference/replicated-cli-api.mdx index 48a10ec47b..8b45461670 100644 --- a/docs/reference/replicated-cli-api.mdx +++ b/docs/reference/replicated-cli-api.mdx @@ -11,9 +11,10 @@ Make ad-hoc API calls to the Replicated API ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-app-create.mdx b/docs/reference/replicated-cli-app-create.mdx index c0de1bb450..c89dfe7460 100644 --- a/docs/reference/replicated-cli-app-create.mdx +++ b/docs/reference/replicated-cli-app-create.mdx @@ -39,9 +39,10 @@ replicated app create "Custom App" --output 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-app-ls.mdx b/docs/reference/replicated-cli-app-ls.mdx index c7c48f3d76..522b8486b0 100644 --- a/docs/reference/replicated-cli-app-ls.mdx +++ b/docs/reference/replicated-cli-app-ls.mdx @@ -50,9 +50,10 @@ replicated app ls "App Name" --output 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-app-rm.mdx b/docs/reference/replicated-cli-app-rm.mdx index ff3dd57e53..3869ade525 100644 --- a/docs/reference/replicated-cli-app-rm.mdx +++ b/docs/reference/replicated-cli-app-rm.mdx @@ -45,9 +45,10 @@ replicated app delete "Custom App" --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-app.mdx b/docs/reference/replicated-cli-app.mdx index 614c06d130..ebdd0dce81 100644 --- a/docs/reference/replicated-cli-app.mdx +++ b/docs/reference/replicated-cli-app.mdx @@ -40,9 +40,10 @@ replicated app ls --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-create.mdx b/docs/reference/replicated-cli-channel-create.mdx index 1aa3c435e8..ffd2b661bd 100644 --- a/docs/reference/replicated-cli-channel-create.mdx +++ b/docs/reference/replicated-cli-channel-create.mdx @@ -28,9 +28,10 @@ replicated channel create --name Beta --description 'New features subject to cha ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-demote.mdx b/docs/reference/replicated-cli-channel-demote.mdx index 81fc60c758..7917ff2d9e 100644 --- a/docs/reference/replicated-cli-channel-demote.mdx +++ b/docs/reference/replicated-cli-channel-demote.mdx @@ -31,9 +31,10 @@ replicated channel demote CHANNEL_ID_OR_NAME [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx b/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx index 63bfb06935..9938ce86b1 100644 --- a/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx +++ b/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx @@ -25,9 +25,10 @@ replicated channel disable-semantic-versioning CHANNEL_ID ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx b/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx index 44a4b21747..2de758da79 100644 --- a/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx +++ b/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx @@ -25,9 +25,10 @@ replicated channel enable-semantic-versioning CHANNEL_ID ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-inspect.mdx b/docs/reference/replicated-cli-channel-inspect.mdx index 9784ac5de7..0332220611 100644 --- a/docs/reference/replicated-cli-channel-inspect.mdx +++ b/docs/reference/replicated-cli-channel-inspect.mdx @@ -20,9 +20,10 @@ replicated channel inspect CHANNEL_ID [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-ls.mdx b/docs/reference/replicated-cli-channel-ls.mdx index 9c3e73df1a..f37bd3bda2 100644 --- a/docs/reference/replicated-cli-channel-ls.mdx +++ b/docs/reference/replicated-cli-channel-ls.mdx @@ -26,9 +26,10 @@ ls, list ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-rm.mdx b/docs/reference/replicated-cli-channel-rm.mdx index 8b0c9c937d..07dccd8537 100644 --- a/docs/reference/replicated-cli-channel-rm.mdx +++ b/docs/reference/replicated-cli-channel-rm.mdx @@ -25,9 +25,10 @@ rm, delete ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel-un-demote.mdx b/docs/reference/replicated-cli-channel-un-demote.mdx index 0caf3f3573..22326fef9e 100644 --- a/docs/reference/replicated-cli-channel-un-demote.mdx +++ b/docs/reference/replicated-cli-channel-un-demote.mdx @@ -31,9 +31,10 @@ replicated channel un-demote CHANNEL_ID_OR_NAME [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-channel.mdx b/docs/reference/replicated-cli-channel.mdx index 574f7d5307..523dbe02ca 100644 --- a/docs/reference/replicated-cli-channel.mdx +++ b/docs/reference/replicated-cli-channel.mdx @@ -15,9 +15,10 @@ List channels ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO 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 73172c1215..dfbd77a207 100644 --- a/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx +++ b/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx @@ -42,9 +42,10 @@ replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-addon-create.mdx b/docs/reference/replicated-cli-cluster-addon-create.mdx index 7baef980a7..2ffae96b05 100644 --- a/docs/reference/replicated-cli-cluster-addon-create.mdx +++ b/docs/reference/replicated-cli-cluster-addon-create.mdx @@ -25,9 +25,10 @@ replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-addon-ls.mdx b/docs/reference/replicated-cli-cluster-addon-ls.mdx index c1edd2d3f3..caade15c31 100644 --- a/docs/reference/replicated-cli-cluster-addon-ls.mdx +++ b/docs/reference/replicated-cli-cluster-addon-ls.mdx @@ -41,9 +41,10 @@ replicated cluster addon ls CLUSTER_ID_OR_NAME --output wide ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-addon-rm.mdx b/docs/reference/replicated-cli-cluster-addon-rm.mdx index 434f2b57f3..e4556120d7 100644 --- a/docs/reference/replicated-cli-cluster-addon-rm.mdx +++ b/docs/reference/replicated-cli-cluster-addon-rm.mdx @@ -35,9 +35,10 @@ replicated cluster addon rm cluster456 --id abc123 ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-addon.mdx b/docs/reference/replicated-cli-cluster-addon.mdx index 66ea703871..248a4277d0 100644 --- a/docs/reference/replicated-cli-cluster-addon.mdx +++ b/docs/reference/replicated-cli-cluster-addon.mdx @@ -33,9 +33,10 @@ replicated cluster addon ls CLUSTER_ID_OR_NAME --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-create.mdx b/docs/reference/replicated-cli-cluster-create.mdx index 5712525b99..d4b3357eba 100644 --- a/docs/reference/replicated-cli-cluster-create.mdx +++ b/docs/reference/replicated-cli-cluster-create.mdx @@ -69,9 +69,10 @@ replicated cluster create --distribution eks --version 1.21 --nodes 3 --addon ob ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-kubeconfig.mdx b/docs/reference/replicated-cli-cluster-kubeconfig.mdx index 555ddf4be8..c6d4ec1aac 100644 --- a/docs/reference/replicated-cli-cluster-kubeconfig.mdx +++ b/docs/reference/replicated-cli-cluster-kubeconfig.mdx @@ -46,9 +46,10 @@ replicated cluster kubeconfig --id CLUSTER_ID ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-ls.mdx b/docs/reference/replicated-cli-cluster-ls.mdx index d91e0f6bcd..f1323e7abb 100644 --- a/docs/reference/replicated-cli-cluster-ls.mdx +++ b/docs/reference/replicated-cli-cluster-ls.mdx @@ -56,9 +56,10 @@ replicated cluster ls --output wide ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx index 1f2daa20d7..72995072ad 100644 --- a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx +++ b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx @@ -43,9 +43,10 @@ replicated cluster nodegroup ls CLUSTER_ID_OR_NAME --output wide ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-nodegroup.mdx b/docs/reference/replicated-cli-cluster-nodegroup.mdx index aa55a7b20c..b3ab0cbd7a 100644 --- a/docs/reference/replicated-cli-cluster-nodegroup.mdx +++ b/docs/reference/replicated-cli-cluster-nodegroup.mdx @@ -24,9 +24,10 @@ replicated cluster nodegroup ls CLUSTER_ID_OR_NAME ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-port-expose.mdx b/docs/reference/replicated-cli-cluster-port-expose.mdx index 15b35fcfa6..3a6059cbf1 100644 --- a/docs/reference/replicated-cli-cluster-port-expose.mdx +++ b/docs/reference/replicated-cli-cluster-port-expose.mdx @@ -45,9 +45,10 @@ replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol https - ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-port-ls.mdx b/docs/reference/replicated-cli-cluster-port-ls.mdx index 35b6647a33..bcdf62498f 100644 --- a/docs/reference/replicated-cli-cluster-port-ls.mdx +++ b/docs/reference/replicated-cli-cluster-port-ls.mdx @@ -41,9 +41,10 @@ replicated cluster port ls CLUSTER_ID_OR_NAME --output wide ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-port-rm.mdx b/docs/reference/replicated-cli-cluster-port-rm.mdx index 330172645a..a59492de21 100644 --- a/docs/reference/replicated-cli-cluster-port-rm.mdx +++ b/docs/reference/replicated-cli-cluster-port-rm.mdx @@ -44,9 +44,10 @@ replicated cluster port rm CLUSTER_ID_OR_NAME --id PORT_ID --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-port.mdx b/docs/reference/replicated-cli-cluster-port.mdx index e786cb6ff1..0187fa60d8 100644 --- a/docs/reference/replicated-cli-cluster-port.mdx +++ b/docs/reference/replicated-cli-cluster-port.mdx @@ -30,9 +30,10 @@ replicated cluster port expose [CLUSTER_ID_OR_NAME] [PORT] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-prepare.mdx b/docs/reference/replicated-cli-cluster-prepare.mdx index 04180d962c..80ca42b927 100644 --- a/docs/reference/replicated-cli-cluster-prepare.mdx +++ b/docs/reference/replicated-cli-cluster-prepare.mdx @@ -59,9 +59,10 @@ replicated cluster prepare --distribution eks --version 1.27 --instance-type c6. ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-rm.mdx b/docs/reference/replicated-cli-cluster-rm.mdx index 2791f46a38..6d8dfab435 100644 --- a/docs/reference/replicated-cli-cluster-rm.mdx +++ b/docs/reference/replicated-cli-cluster-rm.mdx @@ -50,9 +50,10 @@ replicated cluster rm --all ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-shell.mdx b/docs/reference/replicated-cli-cluster-shell.mdx index 6742e8bf1e..820734a458 100644 --- a/docs/reference/replicated-cli-cluster-shell.mdx +++ b/docs/reference/replicated-cli-cluster-shell.mdx @@ -38,9 +38,10 @@ replicated cluster shell --id CLUSTER_ID ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-update-nodegroup.mdx b/docs/reference/replicated-cli-cluster-update-nodegroup.mdx index 5b98421416..382d561219 100644 --- a/docs/reference/replicated-cli-cluster-update-nodegroup.mdx +++ b/docs/reference/replicated-cli-cluster-update-nodegroup.mdx @@ -37,11 +37,12 @@ replicated cluster update nodegroup CLUSTER_ID_OR_NAME --nodegroup-id NODEGROUP_ ### 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 + --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. + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-update-ttl.mdx b/docs/reference/replicated-cli-cluster-update-ttl.mdx index b7903f9600..c91bef7f74 100644 --- a/docs/reference/replicated-cli-cluster-update-ttl.mdx +++ b/docs/reference/replicated-cli-cluster-update-ttl.mdx @@ -28,11 +28,12 @@ replicated cluster update ttl CLUSTER_ID_OR_NAME --ttl 24h ### 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 + --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. + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-update.mdx b/docs/reference/replicated-cli-cluster-update.mdx index 1fe5c2396e..792dfc6bcf 100644 --- a/docs/reference/replicated-cli-cluster-update.mdx +++ b/docs/reference/replicated-cli-cluster-update.mdx @@ -29,9 +29,10 @@ replicated cluster update --name [subcommand] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-upgrade.mdx b/docs/reference/replicated-cli-cluster-upgrade.mdx index a3483bd437..0179edff89 100644 --- a/docs/reference/replicated-cli-cluster-upgrade.mdx +++ b/docs/reference/replicated-cli-cluster-upgrade.mdx @@ -36,9 +36,10 @@ replicated cluster upgrade CLUSTER_ID_OR_NAME --version 1.31 --wait 30m ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster-versions.mdx b/docs/reference/replicated-cli-cluster-versions.mdx index 91b902c5a5..ee81a27f47 100644 --- a/docs/reference/replicated-cli-cluster-versions.mdx +++ b/docs/reference/replicated-cli-cluster-versions.mdx @@ -34,9 +34,10 @@ replicated cluster versions --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-cluster.mdx b/docs/reference/replicated-cli-cluster.mdx index 41ffa5cd27..52f7361302 100644 --- a/docs/reference/replicated-cli-cluster.mdx +++ b/docs/reference/replicated-cli-cluster.mdx @@ -31,9 +31,10 @@ replicated cluster nodegroup ls ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-completion.mdx b/docs/reference/replicated-cli-completion.mdx index 02742c3fe1..b59234bf49 100644 --- a/docs/reference/replicated-cli-completion.mdx +++ b/docs/reference/replicated-cli-completion.mdx @@ -62,9 +62,10 @@ PowerShell: ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-config-init.mdx b/docs/reference/replicated-cli-config-init.mdx new file mode 100644 index 0000000000..11b9da875d --- /dev/null +++ b/docs/reference/replicated-cli-config-init.mdx @@ -0,0 +1,51 @@ +# replicated config init + +Initialize a .replicated config file for your project + +### Synopsis + +Initialize a .replicated config file for your project. + +This command will guide you through setting up a .replicated configuration file +by prompting for common settings like app ID, chart paths, and linting preferences. + +It will also attempt to auto-detect Helm charts and preflight specs in your project. + +``` +replicated config init [flags] +``` + +### Examples + +``` +# Initialize with interactive prompts +replicated config init + +# Initialize with auto-detected resources only (no prompts) +replicated config init --non-interactive + +# Initialize without auto-detection +replicated config init --skip-detection +``` + +### Options + +``` + -h, --help help for init + --non-interactive Run without prompts, using defaults and auto-detected values + --skip-detection Skip auto-detection of resources +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated config](replicated-cli-config) - Manage .replicated configuration + diff --git a/docs/reference/replicated-cli-config.mdx b/docs/reference/replicated-cli-config.mdx new file mode 100644 index 0000000000..52ca8ab4ac --- /dev/null +++ b/docs/reference/replicated-cli-config.mdx @@ -0,0 +1,28 @@ +# replicated config + +Manage .replicated configuration + +### Synopsis + +Manage .replicated configuration files for your project. + +### Options + +``` + -h, --help help for config +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated config init](replicated-cli-config-init) - Initialize a .replicated config file for your project + diff --git a/docs/reference/replicated-cli-customer-archive.mdx b/docs/reference/replicated-cli-customer-archive.mdx index 41c977df8d..9856f5b80a 100644 --- a/docs/reference/replicated-cli-customer-archive.mdx +++ b/docs/reference/replicated-cli-customer-archive.mdx @@ -42,8 +42,9 @@ 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 + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-customer-create.mdx b/docs/reference/replicated-cli-customer-create.mdx index 7583d2615a..09fb34b0d8 100644 --- a/docs/reference/replicated-cli-customer-create.mdx +++ b/docs/reference/replicated-cli-customer-create.mdx @@ -71,9 +71,10 @@ replicated customer create --app myapp --name "Full Options Inc" --custom-id "FU ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-customer-download-license.mdx b/docs/reference/replicated-cli-customer-download-license.mdx index b94d8e4680..c54836f9ee 100644 --- a/docs/reference/replicated-cli-customer-download-license.mdx +++ b/docs/reference/replicated-cli-customer-download-license.mdx @@ -40,9 +40,10 @@ replicated customer download-license --app myapp --customer "Acme Inc" --output ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-customer-inspect.mdx b/docs/reference/replicated-cli-customer-inspect.mdx index a7016ab427..1e4acb8135 100644 --- a/docs/reference/replicated-cli-customer-inspect.mdx +++ b/docs/reference/replicated-cli-customer-inspect.mdx @@ -43,9 +43,10 @@ replicated customer inspect --app myapp --customer "Acme Inc" ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-customer-ls.mdx b/docs/reference/replicated-cli-customer-ls.mdx index 4fdc00c9d8..97bc8b87e6 100644 --- a/docs/reference/replicated-cli-customer-ls.mdx +++ b/docs/reference/replicated-cli-customer-ls.mdx @@ -48,9 +48,10 @@ replicated customer ls --app myapp --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-customer-update.mdx b/docs/reference/replicated-cli-customer-update.mdx index ab98a2b4a3..37b1d1ebf0 100644 --- a/docs/reference/replicated-cli-customer-update.mdx +++ b/docs/reference/replicated-cli-customer-update.mdx @@ -70,9 +70,10 @@ replicated customer update --customer cus_abcdef123456 --name "JSON Corp" --outp ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-customer.mdx b/docs/reference/replicated-cli-customer.mdx index f79228f769..c94edefc7a 100644 --- a/docs/reference/replicated-cli-customer.mdx +++ b/docs/reference/replicated-cli-customer.mdx @@ -15,9 +15,10 @@ The customers command allows vendors to create, display, modify end customer rec ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-default-clear-all.mdx b/docs/reference/replicated-cli-default-clear-all.mdx index baeea8174b..bc76e90cce 100644 --- a/docs/reference/replicated-cli-default-clear-all.mdx +++ b/docs/reference/replicated-cli-default-clear-all.mdx @@ -28,9 +28,10 @@ replicated default clear-all ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-default-clear.mdx b/docs/reference/replicated-cli-default-clear.mdx index 409fbac9bb..2b6cf16b1b 100644 --- a/docs/reference/replicated-cli-default-clear.mdx +++ b/docs/reference/replicated-cli-default-clear.mdx @@ -31,9 +31,10 @@ replicated default clear app ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-default-set.mdx b/docs/reference/replicated-cli-default-set.mdx index ff204c973b..cd62ccf158 100644 --- a/docs/reference/replicated-cli-default-set.mdx +++ b/docs/reference/replicated-cli-default-set.mdx @@ -35,9 +35,10 @@ replicated default set app my-app-slug ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-default-show.mdx b/docs/reference/replicated-cli-default-show.mdx index 9b54e375bd..59a3e1ef23 100644 --- a/docs/reference/replicated-cli-default-show.mdx +++ b/docs/reference/replicated-cli-default-show.mdx @@ -36,9 +36,10 @@ replicated default show app ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-default.mdx b/docs/reference/replicated-cli-default.mdx index df39875418..354e868a31 100644 --- a/docs/reference/replicated-cli-default.mdx +++ b/docs/reference/replicated-cli-default.mdx @@ -11,9 +11,10 @@ Manage default values used by other commands ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-installer-create.mdx b/docs/reference/replicated-cli-installer-create.mdx index 8cb54d2a15..26a63bb7e9 100644 --- a/docs/reference/replicated-cli-installer-create.mdx +++ b/docs/reference/replicated-cli-installer-create.mdx @@ -25,9 +25,10 @@ replicated installer create [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-installer-ls.mdx b/docs/reference/replicated-cli-installer-ls.mdx index 7b2e6326d9..f4e7e1914d 100644 --- a/docs/reference/replicated-cli-installer-ls.mdx +++ b/docs/reference/replicated-cli-installer-ls.mdx @@ -26,9 +26,10 @@ ls, list ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-installer.mdx b/docs/reference/replicated-cli-installer.mdx index a11abe2d95..b57bd3ba5a 100644 --- a/docs/reference/replicated-cli-installer.mdx +++ b/docs/reference/replicated-cli-installer.mdx @@ -15,9 +15,10 @@ The installers command allows vendors to create, display, modify and promote kur ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-instance-inspect.mdx b/docs/reference/replicated-cli-instance-inspect.mdx index 3c26594345..3d5672522d 100644 --- a/docs/reference/replicated-cli-instance-inspect.mdx +++ b/docs/reference/replicated-cli-instance-inspect.mdx @@ -22,9 +22,10 @@ replicated instance inspect [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-instance-ls.mdx b/docs/reference/replicated-cli-instance-ls.mdx index 51be5a92b6..7a589820d0 100644 --- a/docs/reference/replicated-cli-instance-ls.mdx +++ b/docs/reference/replicated-cli-instance-ls.mdx @@ -28,9 +28,10 @@ ls, list ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-instance-tag.mdx b/docs/reference/replicated-cli-instance-tag.mdx index aa0904749e..1ee26580b7 100644 --- a/docs/reference/replicated-cli-instance-tag.mdx +++ b/docs/reference/replicated-cli-instance-tag.mdx @@ -23,9 +23,10 @@ replicated instance tag [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-instance.mdx b/docs/reference/replicated-cli-instance.mdx index 4dea77ceaf..0770193841 100644 --- a/docs/reference/replicated-cli-instance.mdx +++ b/docs/reference/replicated-cli-instance.mdx @@ -15,9 +15,10 @@ The instance command allows vendors to display and tag customer instances. ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-login.mdx b/docs/reference/replicated-cli-login.mdx index a1e9c643ad..4f11cdeb49 100644 --- a/docs/reference/replicated-cli-login.mdx +++ b/docs/reference/replicated-cli-login.mdx @@ -19,9 +19,10 @@ replicated login [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-logout.mdx b/docs/reference/replicated-cli-logout.mdx index 15d700b6c0..f50d50bc45 100644 --- a/docs/reference/replicated-cli-logout.mdx +++ b/docs/reference/replicated-cli-logout.mdx @@ -19,9 +19,10 @@ replicated logout [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-network-ls.mdx b/docs/reference/replicated-cli-network-ls.mdx index 30f885b3c7..fb8b72d523 100644 --- a/docs/reference/replicated-cli-network-ls.mdx +++ b/docs/reference/replicated-cli-network-ls.mdx @@ -18,6 +18,8 @@ ls, list --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") + --show-reports when set, only show networks that have reports + --show-terminated when set, only show terminated networks --start-time string start time for the query (Format: 2006-01-02T15:04:05Z) -w, --watch watch networks ``` @@ -25,9 +27,10 @@ ls, list ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-network-report.mdx b/docs/reference/replicated-cli-network-report.mdx deleted file mode 100644 index b0cddecd0d..0000000000 --- a/docs/reference/replicated-cli-network-report.mdx +++ /dev/null @@ -1,49 +0,0 @@ -# replicated network report - -Get network report - -### Synopsis - -Get a report showing network events for a specified network. You can view all network events, or use the --summary flag to see an aggregated analysis of captured network events. - -Network reporting is a beta feature. For more information, see [Test in Air Gap Environments (Beta)](/vendor/testing-network-policy). - -``` -replicated network report [network-id] [flags] -``` - -### Examples - -``` -# Get report for a network by ID (using positional argument) -replicated network report abc123 - -# Get report for a network by ID (using flag) -replicated network report --id abc123 - -# Watch for new network events (JSON Lines format) -replicated network report abc123 --watch -``` - -### Options - -``` - -h, --help help for report - --id string Network ID to get report for - --summary Get the report summary - -w, --watch Watch for new network events -``` - -### 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 network](replicated-cli-network) - Manage test networks for VMs and Clusters - - diff --git a/docs/reference/replicated-cli-network-update.mdx b/docs/reference/replicated-cli-network-update.mdx index 14d9294ca2..f193ad9d96 100644 --- a/docs/reference/replicated-cli-network-update.mdx +++ b/docs/reference/replicated-cli-network-update.mdx @@ -4,11 +4,13 @@ Update network settings ### Synopsis -The 'update' command allows you to update various settings of a test network. +The 'update' command allows you to update various settings of a test network, including network policy and report collection. -You can either specify the network ID directly or provide the network name, and the command will resolve the corresponding network ID. +You can either specify the network ID or name directly as a positional argument, or provide it using the '--id' or '--name' flags. -Network Policies are currently a beta feature. +Network policies control network traffic behavior: + - open: No restrictions on network traffic (default) + - airgap: Blocks all network egress to simulate air-gapped environments ``` replicated network update [ID_OR_NAME] [flags] @@ -17,34 +19,41 @@ replicated network update [ID_OR_NAME] [flags] ### Examples ``` -# Update a network using its ID +# Set network policy to airgap replicated network update --policy airgap -# Update a network using its name -replicated network update --policy airgap +# Set network policy to open +replicated network update --policy open -# Update using --id or --name flags -replicated network update --id --policy airgap -replicated network update --name --policy airgap +# Enable network traffic reporting +replicated network update --collect-report + +# Disable network reporting +replicated network update --collect-report=false + +# Update multiple settings at once +replicated network update --policy airgap --collect-report ``` ### Options ``` - -h, --help help for update - --id string id of the network to update (when name is not provided) - --name string Name of the network to update - --output string The output format to use. One of: json|table|wide (default "table") - -p, --policy string Update network policy setting + -r, --collect-report Enable report collection on this network (use --collect-report=false to disable) + -h, --help help for update + --id string id of the network to update (when name is not provided) + --name string Name of the network to update + --output string The output format to use. One of: json|table|wide (default "table") + -p, --policy string Update network policy setting ``` ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-network.mdx b/docs/reference/replicated-cli-network.mdx index 0ce402e7d0..28180ad7bb 100644 --- a/docs/reference/replicated-cli-network.mdx +++ b/docs/reference/replicated-cli-network.mdx @@ -16,9 +16,6 @@ replicated network ls # Update a network with an airgap policy replicated network update --policy airgap -# View network report -replicated network report --summary - ``` ### Options @@ -30,15 +27,15 @@ replicated network report --summary ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO * [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated * [replicated network ls](replicated-cli-network-ls) - List test networks -* [replicated network report](replicated-cli-network-report) - View network activity reports * [replicated network update](replicated-cli-network-update) - Update network settings diff --git a/docs/reference/replicated-cli-profile-add.mdx b/docs/reference/replicated-cli-profile-add.mdx new file mode 100644 index 0000000000..dc6a0eee51 --- /dev/null +++ b/docs/reference/replicated-cli-profile-add.mdx @@ -0,0 +1,56 @@ +# replicated profile add + +Add a new authentication profile + +### Synopsis + +Add a new authentication profile with the specified name. + +You can provide an API token via the --token flag, or you will be prompted to enter it securely. +Optionally, you can specify custom API and registry origins. +If a profile with the same name already exists, it will be updated. + +The profile will be stored in ~/.replicated/config.yaml with file permissions 600 (owner read/write only). + +``` +replicated profile add [profile-name] [flags] +``` + +### Examples + +``` +# Add a production profile (will prompt for token) +replicated profile add prod + +# Add a production profile with token flag +replicated profile add prod --token=your-prod-token + +# Add a development profile with custom origins +replicated profile add dev \ + --token=your-dev-token \ + --api-origin=https://vendor-api-noahecampbell.okteto.repldev.com \ + --registry-origin=vendor-registry-v2-noahecampbell.okteto.repldev.com +``` + +### Options + +``` + --api-origin string API origin (optional, e.g., https://api.replicated.com/vendor). Mutually exclusive with --namespace + -h, --help help for add + --namespace string Okteto namespace for dev environments (e.g., 'noahecampbell'). Auto-generates service URLs. Mutually exclusive with --api-origin and --registry-origin + --registry-origin string Registry origin (optional, e.g., registry.replicated.com). Mutually exclusive with --namespace + --token string API token for this profile (optional, will prompt if not provided) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command +``` + +### SEE ALSO + +* [replicated profile](replicated-cli-profile) - Manage authentication profiles + diff --git a/docs/reference/replicated-cli-profile-edit.mdx b/docs/reference/replicated-cli-profile-edit.mdx new file mode 100644 index 0000000000..09702df6fe --- /dev/null +++ b/docs/reference/replicated-cli-profile-edit.mdx @@ -0,0 +1,55 @@ +# replicated profile edit + +Edit an existing authentication profile + +### Synopsis + +Edit an existing authentication profile. + +You can update the API token, API origin, and/or registry origin for an existing profile. +Only the flags you provide will be updated; other fields will remain unchanged. + +The profile will be stored in ~/.replicated/config.yaml with file permissions 600 (owner read/write only). + +``` +replicated profile edit [profile-name] [flags] +``` + +### Examples + +``` +# Update the token for a profile +replicated profile edit dev --token=new-dev-token + +# Update the API origin for a profile +replicated profile edit dev --api-origin=https://vendor-api-noahecampbell.okteto.repldev.com + +# Update multiple fields at once +replicated profile edit dev \ + --token=new-token \ + --api-origin=https://vendor-api-noahecampbell.okteto.repldev.com \ + --registry-origin=vendor-registry-v2-noahecampbell.okteto.repldev.com +``` + +### Options + +``` + --api-origin string New API origin (optional, e.g., https://api.replicated.com/vendor). Mutually exclusive with --namespace + -h, --help help for edit + --namespace string Okteto namespace for dev environments (e.g., 'noahecampbell'). Auto-generates service URLs. Mutually exclusive with --api-origin and --registry-origin + --registry-origin string New registry origin (optional, e.g., registry.replicated.com). Mutually exclusive with --namespace + --token string New API token for this profile (optional) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command +``` + +### SEE ALSO + +* [replicated profile](replicated-cli-profile) - Manage authentication profiles + diff --git a/docs/reference/replicated-cli-profile-ls.mdx b/docs/reference/replicated-cli-profile-ls.mdx new file mode 100644 index 0000000000..e31d803d26 --- /dev/null +++ b/docs/reference/replicated-cli-profile-ls.mdx @@ -0,0 +1,40 @@ +# replicated profile ls + +List all authentication profiles + +### Synopsis + +List all authentication profiles configured in ~/.replicated/config.yaml. + +The default profile is indicated with an asterisk (*). + +``` +replicated profile ls [flags] +``` + +### Examples + +``` +# List all profiles +replicated profile ls +``` + +### Options + +``` + -h, --help help for ls +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated profile](replicated-cli-profile) - Manage authentication profiles + diff --git a/docs/reference/replicated-cli-profile-rm.mdx b/docs/reference/replicated-cli-profile-rm.mdx new file mode 100644 index 0000000000..90be67684f --- /dev/null +++ b/docs/reference/replicated-cli-profile-rm.mdx @@ -0,0 +1,41 @@ +# replicated profile rm + +Remove an authentication profile + +### Synopsis + +Remove an authentication profile by name. + +If the removed profile was the default profile, the default will be automatically +set to another available profile (if any exist). + +``` +replicated profile rm [profile-name] [flags] +``` + +### Examples + +``` +# Remove a profile +replicated profile rm dev +``` + +### Options + +``` + -h, --help help for rm +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated profile](replicated-cli-profile) - Manage authentication profiles + diff --git a/docs/reference/replicated-cli-profile-set-default.mdx b/docs/reference/replicated-cli-profile-set-default.mdx new file mode 100644 index 0000000000..fabe8109f3 --- /dev/null +++ b/docs/reference/replicated-cli-profile-set-default.mdx @@ -0,0 +1,39 @@ +# replicated profile set-default + +Set the default authentication profile + +### Synopsis + +Set the default authentication profile that will be used when no --profile flag is specified +and no environment variables are set. + +``` +replicated profile set-default [profile-name] [flags] +``` + +### Examples + +``` +# Set production as the default profile +replicated profile set-default prod +``` + +### Options + +``` + -h, --help help for set-default +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated profile](replicated-cli-profile) - Manage authentication profiles + diff --git a/docs/reference/replicated-cli-profile-use.mdx b/docs/reference/replicated-cli-profile-use.mdx new file mode 100644 index 0000000000..70a1725a53 --- /dev/null +++ b/docs/reference/replicated-cli-profile-use.mdx @@ -0,0 +1,39 @@ +# replicated profile use + +Set the default authentication profile + +### Synopsis + +Set the default authentication profile that will be used when no --profile flag is specified +and no environment variables are set. + +``` +replicated profile use [profile-name] [flags] +``` + +### Examples + +``` +# Use production as the default profile +replicated profile use prod +``` + +### Options + +``` + -h, --help help for use +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated profile](replicated-cli-profile) - Manage authentication profiles + diff --git a/docs/reference/replicated-cli-profile.mdx b/docs/reference/replicated-cli-profile.mdx new file mode 100644 index 0000000000..115e0855a5 --- /dev/null +++ b/docs/reference/replicated-cli-profile.mdx @@ -0,0 +1,77 @@ +# replicated profile + +Manage authentication profiles + +### Synopsis + +The profile command allows you to manage authentication profiles for the Replicated CLI. + +Profiles let you store multiple sets of credentials and easily switch between them. +This is useful when working with different Replicated accounts (production, development, etc.) +or different API endpoints. + +Credentials are stored in ~/.replicated/config.yaml with file permissions set to 600 (owner read/write only). + +Authentication priority: +1. REPLICATED_API_TOKEN environment variable (highest priority) +2. --profile flag (per-command override) +3. Default profile from ~/.replicated/config.yaml +4. Legacy single token (backward compatibility) + +Use the various subcommands to: +- Add new profiles +- Edit existing profiles +- List all profiles +- Remove profiles +- Set the default profile + +### Examples + +``` +# Add a production profile (will prompt for token) +replicated profile add prod + +# Add a production profile with token flag +replicated profile add prod --token=your-prod-token + +# Add a development profile with custom API origin +replicated profile add dev --token=your-dev-token --api-origin=https://vendor-api-dev.com + +# Edit an existing profile's API origin +replicated profile edit dev --api-origin=https://vendor-api-noahecampbell.okteto.repldev.com + +# List all profiles +replicated profile ls + +# Set default profile +replicated profile set-default prod + +# Remove a profile +replicated profile rm dev +``` + +### Options + +``` + -h, --help help for profile +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated profile add](replicated-cli-profile-add) - Add a new authentication profile +* [replicated profile edit](replicated-cli-profile-edit) - Edit an existing authentication profile +* [replicated profile ls](replicated-cli-profile-ls) - List all authentication profiles +* [replicated profile rm](replicated-cli-profile-rm) - Remove an authentication profile +* [replicated profile set-default](replicated-cli-profile-set-default) - Set the default authentication profile +* [replicated profile use](replicated-cli-profile-use) - Set the default authentication profile + diff --git a/docs/reference/replicated-cli-registry-add-dockerhub.mdx b/docs/reference/replicated-cli-registry-add-dockerhub.mdx index fe32bb4e0e..912fe449c6 100644 --- a/docs/reference/replicated-cli-registry-add-dockerhub.mdx +++ b/docs/reference/replicated-cli-registry-add-dockerhub.mdx @@ -30,6 +30,7 @@ replicated registry add dockerhub [flags] ``` --app string The app slug or app id to use in all calls --debug Enable debug output + --profile string The authentication profile to use for this command --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 c742c72c82..1bbad758df 100644 --- a/docs/reference/replicated-cli-registry-add-ecr.mdx +++ b/docs/reference/replicated-cli-registry-add-ecr.mdx @@ -28,6 +28,7 @@ replicated registry add ecr [flags] ``` --app string The app slug or app id to use in all calls --debug Enable debug output + --profile string The authentication profile to use for this command --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 57781a2b50..94c9c79a18 100644 --- a/docs/reference/replicated-cli-registry-add-gar.mdx +++ b/docs/reference/replicated-cli-registry-add-gar.mdx @@ -30,6 +30,7 @@ replicated registry add gar [flags] ``` --app string The app slug or app id to use in all calls --debug Enable debug output + --profile string The authentication profile to use for this command --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 6812a9b4f3..33cee6ceee 100644 --- a/docs/reference/replicated-cli-registry-add-gcr.mdx +++ b/docs/reference/replicated-cli-registry-add-gcr.mdx @@ -27,6 +27,7 @@ replicated registry add gcr [flags] ``` --app string The app slug or app id to use in all calls --debug Enable debug output + --profile string The authentication profile to use for this command --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 096360c23c..3aa340a65a 100644 --- a/docs/reference/replicated-cli-registry-add-ghcr.mdx +++ b/docs/reference/replicated-cli-registry-add-ghcr.mdx @@ -26,6 +26,7 @@ replicated registry add ghcr [flags] ``` --app string The app slug or app id to use in all calls --debug Enable debug output + --profile string The authentication profile to use for this command --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 bc987098bf..e1b340d4d9 100644 --- a/docs/reference/replicated-cli-registry-add-other.mdx +++ b/docs/reference/replicated-cli-registry-add-other.mdx @@ -28,6 +28,7 @@ replicated registry add other [flags] ``` --app string The app slug or app id to use in all calls --debug Enable debug output + --profile string The authentication profile to use for this command --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 63d4e839a8..d67890d33e 100644 --- a/docs/reference/replicated-cli-registry-add-quay.mdx +++ b/docs/reference/replicated-cli-registry-add-quay.mdx @@ -27,6 +27,7 @@ replicated registry add quay [flags] ``` --app string The app slug or app id to use in all calls --debug Enable debug output + --profile string The authentication profile to use for this command --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 2273232957..745137da29 100644 --- a/docs/reference/replicated-cli-registry-add.mdx +++ b/docs/reference/replicated-cli-registry-add.mdx @@ -16,9 +16,10 @@ add ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-registry-ls.mdx b/docs/reference/replicated-cli-registry-ls.mdx index 0212c63b41..c058b08131 100644 --- a/docs/reference/replicated-cli-registry-ls.mdx +++ b/docs/reference/replicated-cli-registry-ls.mdx @@ -26,9 +26,10 @@ ls, list ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-registry-rm.mdx b/docs/reference/replicated-cli-registry-rm.mdx index 4912018608..96a37f0d17 100644 --- a/docs/reference/replicated-cli-registry-rm.mdx +++ b/docs/reference/replicated-cli-registry-rm.mdx @@ -25,9 +25,10 @@ rm, delete ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-registry-test.mdx b/docs/reference/replicated-cli-registry-test.mdx index 11851cf18d..eb54f5edff 100644 --- a/docs/reference/replicated-cli-registry-test.mdx +++ b/docs/reference/replicated-cli-registry-test.mdx @@ -20,9 +20,10 @@ replicated registry test NAME [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-registry.mdx b/docs/reference/replicated-cli-registry.mdx index 5348536ab6..b716c59b62 100644 --- a/docs/reference/replicated-cli-registry.mdx +++ b/docs/reference/replicated-cli-registry.mdx @@ -15,9 +15,10 @@ registry can be used to manage existing registries and add new registries to a t ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-compatibility.mdx b/docs/reference/replicated-cli-release-compatibility.mdx index a9b815bf5a..6f34a7f00e 100644 --- a/docs/reference/replicated-cli-release-compatibility.mdx +++ b/docs/reference/replicated-cli-release-compatibility.mdx @@ -24,9 +24,10 @@ replicated release compatibility SEQUENCE [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-create.mdx b/docs/reference/replicated-cli-release-create.mdx index c6b17d93f8..35945baf72 100644 --- a/docs/reference/replicated-cli-release-create.mdx +++ b/docs/reference/replicated-cli-release-create.mdx @@ -20,6 +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. + -o, --output string The output format to use. One of: json|table (default "table") --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 @@ -29,9 +30,10 @@ replicated release create [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-download.mdx b/docs/reference/replicated-cli-release-download.mdx index 36e1c28715..84d4decddc 100644 --- a/docs/reference/replicated-cli-release-download.mdx +++ b/docs/reference/replicated-cli-release-download.mdx @@ -28,9 +28,10 @@ replicated release download 1 --dest ./manifests ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-image-ls.mdx b/docs/reference/replicated-cli-release-image-ls.mdx index 1f64a077e3..8959bda9f5 100644 --- a/docs/reference/replicated-cli-release-image-ls.mdx +++ b/docs/reference/replicated-cli-release-image-ls.mdx @@ -38,9 +38,10 @@ replicated release image ls --channel Stable --keep-proxy ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-image.mdx b/docs/reference/replicated-cli-release-image.mdx index ea65d1c337..6d0260c2e3 100644 --- a/docs/reference/replicated-cli-release-image.mdx +++ b/docs/reference/replicated-cli-release-image.mdx @@ -15,9 +15,10 @@ Manage release images ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-inspect.mdx b/docs/reference/replicated-cli-release-inspect.mdx index 0824af6c49..36b07746b9 100644 --- a/docs/reference/replicated-cli-release-inspect.mdx +++ b/docs/reference/replicated-cli-release-inspect.mdx @@ -36,9 +36,10 @@ replicated release inspect 123 --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-lint.mdx b/docs/reference/replicated-cli-release-lint.mdx index 0cf05e7175..cbb433380b 100644 --- a/docs/reference/replicated-cli-release-lint.mdx +++ b/docs/reference/replicated-cli-release-lint.mdx @@ -1,10 +1,10 @@ # replicated release lint -Lint a directory of KOTS manifests +Lint a directory of KOTS manifests or local resources ### Synopsis -Lint a directory of KOTS manifests +Lint a directory of KOTS manifests or local resources. Behavior depends on the release-validation-v2 feature flag. ``` replicated release lint [flags] @@ -16,15 +16,17 @@ 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 -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. + -v, --verbose Show detailed output including extracted container images (local lint only) + --yaml-dir yaml The directory containing multiple yamls for a Kots release. Cannot be used with the yaml flag. ``` ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-ls.mdx b/docs/reference/replicated-cli-release-ls.mdx index 208b88e931..4c76920a6c 100644 --- a/docs/reference/replicated-cli-release-ls.mdx +++ b/docs/reference/replicated-cli-release-ls.mdx @@ -26,9 +26,10 @@ ls, list ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-promote.mdx b/docs/reference/replicated-cli-release-promote.mdx index c8e50800cd..8ef818ea92 100644 --- a/docs/reference/replicated-cli-release-promote.mdx +++ b/docs/reference/replicated-cli-release-promote.mdx @@ -29,9 +29,10 @@ replicated release promote 15 fe4901690971757689f022f7a460f9b2 ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-test.mdx b/docs/reference/replicated-cli-release-test.mdx index ac5ef228c8..1dfd28f22c 100644 --- a/docs/reference/replicated-cli-release-test.mdx +++ b/docs/reference/replicated-cli-release-test.mdx @@ -19,9 +19,10 @@ replicated release test SEQUENCE [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release-update.mdx b/docs/reference/replicated-cli-release-update.mdx index b23909ade4..74ed12832a 100644 --- a/docs/reference/replicated-cli-release-update.mdx +++ b/docs/reference/replicated-cli-release-update.mdx @@ -22,9 +22,10 @@ replicated release update SEQUENCE [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-release.mdx b/docs/reference/replicated-cli-release.mdx index 3b154a26c9..030db7b31a 100644 --- a/docs/reference/replicated-cli-release.mdx +++ b/docs/reference/replicated-cli-release.mdx @@ -15,9 +15,10 @@ The release command allows vendors to create, display, and promote their release ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO @@ -28,7 +29,7 @@ The release command allows vendors to create, display, and promote their release * [replicated release download](replicated-cli-release-download) - Download application manifests for a release. * [replicated release image](replicated-cli-release-image) - Manage release images * [replicated release inspect](replicated-cli-release-inspect) - Long: information about a release -* [replicated release lint](replicated-cli-release-lint) - Lint a directory of KOTS manifests +* [replicated release lint](replicated-cli-release-lint) - Lint a directory of KOTS manifests or local resources * [replicated release ls](replicated-cli-release-ls) - List all of an app's releases * [replicated release promote](replicated-cli-release-promote) - Set the release for a channel * [replicated release test](replicated-cli-release-test) - Test the application release diff --git a/docs/reference/replicated-cli-version-upgrade.mdx b/docs/reference/replicated-cli-version-upgrade.mdx index 162a60d9c5..b7b5d68eb3 100644 --- a/docs/reference/replicated-cli-version-upgrade.mdx +++ b/docs/reference/replicated-cli-version-upgrade.mdx @@ -19,9 +19,10 @@ replicated version upgrade [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-version.mdx b/docs/reference/replicated-cli-version.mdx index 71c532add2..30e0307874 100644 --- a/docs/reference/replicated-cli-version.mdx +++ b/docs/reference/replicated-cli-version.mdx @@ -20,9 +20,10 @@ replicated version [flags] ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-create.mdx b/docs/reference/replicated-cli-vm-create.mdx index 683fb59bc5..1db9b59791 100644 --- a/docs/reference/replicated-cli-vm-create.mdx +++ b/docs/reference/replicated-cli-vm-create.mdx @@ -59,9 +59,10 @@ replicated vm create --distribution ubuntu --version 20.04 --ssh-public-key ~/.s ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-ls.mdx b/docs/reference/replicated-cli-vm-ls.mdx index 46a2310886..9a3a9dc970 100644 --- a/docs/reference/replicated-cli-vm-ls.mdx +++ b/docs/reference/replicated-cli-vm-ls.mdx @@ -54,9 +54,10 @@ replicated vm ls --watch ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-port-expose.mdx b/docs/reference/replicated-cli-vm-port-expose.mdx index 1825915950..5f9c2d8270 100644 --- a/docs/reference/replicated-cli-vm-port-expose.mdx +++ b/docs/reference/replicated-cli-vm-port-expose.mdx @@ -42,9 +42,10 @@ replicated vm port expose VM_ID_OR_NAME --port 8080 --protocol https --output js ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-port-ls.mdx b/docs/reference/replicated-cli-vm-port-ls.mdx index 4d3e9b9786..67536963b8 100644 --- a/docs/reference/replicated-cli-vm-port-ls.mdx +++ b/docs/reference/replicated-cli-vm-port-ls.mdx @@ -37,9 +37,10 @@ replicated vm port ls VM_ID_OR_NAME --output wide ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-port-rm.mdx b/docs/reference/replicated-cli-vm-port-rm.mdx index 8d9fd33587..d3c17b568a 100644 --- a/docs/reference/replicated-cli-vm-port-rm.mdx +++ b/docs/reference/replicated-cli-vm-port-rm.mdx @@ -35,9 +35,10 @@ replicated vm port rm VM_ID_OR_NAME --id PORT_ID --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-port.mdx b/docs/reference/replicated-cli-vm-port.mdx index 57824e2d62..e00aad2ec2 100644 --- a/docs/reference/replicated-cli-vm-port.mdx +++ b/docs/reference/replicated-cli-vm-port.mdx @@ -32,9 +32,10 @@ replicated vm port expose VM_ID_OR_NAME --port PORT ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-rm.mdx b/docs/reference/replicated-cli-vm-rm.mdx index d86bb8a5cb..99f34b70a6 100644 --- a/docs/reference/replicated-cli-vm-rm.mdx +++ b/docs/reference/replicated-cli-vm-rm.mdx @@ -56,9 +56,10 @@ replicated vm rm --all --dry-run ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-scp-endpoint.mdx b/docs/reference/replicated-cli-vm-scp-endpoint.mdx index c9c8ca9ddf..0fa5448a45 100644 --- a/docs/reference/replicated-cli-vm-scp-endpoint.mdx +++ b/docs/reference/replicated-cli-vm-scp-endpoint.mdx @@ -47,9 +47,10 @@ scp $(replicated vm scp-endpoint my-test-vm)//src/path/my-file /tmp/my-file ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-ssh-endpoint.mdx b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx index 05f3c3c75a..62f8a90c4b 100644 --- a/docs/reference/replicated-cli-vm-ssh-endpoint.mdx +++ b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx @@ -44,9 +44,10 @@ ssh $(replicated vm ssh-endpoint my-test-vm) ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-update-ttl.mdx b/docs/reference/replicated-cli-vm-update-ttl.mdx index 339a423e99..ed9701ff86 100644 --- a/docs/reference/replicated-cli-vm-update-ttl.mdx +++ b/docs/reference/replicated-cli-vm-update-ttl.mdx @@ -39,11 +39,12 @@ replicated vm update ttl my-test-vm --ttl 30m ### 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 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 + --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. + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-update.mdx b/docs/reference/replicated-cli-vm-update.mdx index 2f6bb68b0a..034b1eeab2 100644 --- a/docs/reference/replicated-cli-vm-update.mdx +++ b/docs/reference/replicated-cli-vm-update.mdx @@ -38,9 +38,10 @@ replicated vm update --name my-test-vm --ttl 12h ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm-versions.mdx b/docs/reference/replicated-cli-vm-versions.mdx index f8dbc7c046..ad5e221ff5 100644 --- a/docs/reference/replicated-cli-vm-versions.mdx +++ b/docs/reference/replicated-cli-vm-versions.mdx @@ -39,9 +39,10 @@ replicated vm versions --output json ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated-cli-vm.mdx b/docs/reference/replicated-cli-vm.mdx index 3616867e6d..3627055803 100644 --- a/docs/reference/replicated-cli-vm.mdx +++ b/docs/reference/replicated-cli-vm.mdx @@ -34,9 +34,10 @@ replicated vm update ttl --ttl 24h ### 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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO diff --git a/docs/reference/replicated.mdx b/docs/reference/replicated.mdx index 7d0f5fc04b..b3e5171d37 100644 --- a/docs/reference/replicated.mdx +++ b/docs/reference/replicated.mdx @@ -9,10 +9,11 @@ The 'replicated' CLI allows Replicated customers (vendors) to manage their Comme ### Options ``` - --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 + --app string The app slug or app id to use in all calls + --debug Enable debug output + -h, --help help for replicated + --profile string The authentication profile to use for this command + --token string The API token to use to access your app in the Vendor API ``` ### SEE ALSO @@ -22,6 +23,7 @@ The 'replicated' CLI allows Replicated customers (vendors) to manage their Comme * [replicated channel](replicated-cli-channel) - List channels * [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. * [replicated completion](replicated-cli-completion) - Generate completion script +* [replicated config](replicated-cli-config) - Manage .replicated configuration * [replicated customer](replicated-cli-customer) - Manage customers * [replicated default](replicated-cli-default) - Manage default values used by other commands * [replicated installer](replicated-cli-installer) - Manage Kubernetes installers @@ -29,6 +31,7 @@ The 'replicated' CLI allows Replicated customers (vendors) to manage their Comme * [replicated login](replicated-cli-login) - Log in to Replicated * [replicated logout](replicated-cli-logout) - Logout from Replicated * [replicated network](replicated-cli-network) - Manage test networks for VMs and Clusters +* [replicated profile](replicated-cli-profile) - Manage authentication profiles * [replicated registry](replicated-cli-registry) - Manage registries * [replicated release](replicated-cli-release) - Manage app releases * [replicated version](replicated-cli-version) - Print the current version and exit diff --git a/sidebars.js b/sidebars.js index c5759e313a..a1a240e78a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -651,6 +651,8 @@ const sidebars = { 'reference/replicated-cli-cluster-upgrade', 'reference/replicated-cli-cluster-versions', 'reference/replicated-cli-completion', + 'reference/replicated-cli-config', + 'reference/replicated-cli-config-init', 'reference/replicated-cli-customer', 'reference/replicated-cli-customer-archive', 'reference/replicated-cli-customer-create', @@ -674,8 +676,14 @@ const sidebars = { 'reference/replicated-cli-logout', 'reference/replicated-cli-network', 'reference/replicated-cli-network-ls', - 'reference/replicated-cli-network-report', 'reference/replicated-cli-network-update', + 'reference/replicated-cli-profile', + 'reference/replicated-cli-profile-add', + 'reference/replicated-cli-profile-edit', + 'reference/replicated-cli-profile-ls', + 'reference/replicated-cli-profile-rm', + 'reference/replicated-cli-profile-set-default', + 'reference/replicated-cli-profile-use', 'reference/replicated-cli-registry', 'reference/replicated-cli-registry-add', 'reference/replicated-cli-registry-add-dockerhub', @@ -891,4 +899,4 @@ const sidebars = { ], }; -module.exports = sidebars; +module.exports = sidebars; \ No newline at end of file