diff --git a/docs/reference/replicated-cli-app-ls.mdx b/docs/reference/replicated-cli-app-ls.mdx index 80eb4e54aa..8ae5d79915 100644 --- a/docs/reference/replicated-cli-app-ls.mdx +++ b/docs/reference/replicated-cli-app-ls.mdx @@ -18,6 +18,12 @@ either table or JSON format. replicated app ls [NAME] [flags] ``` +### Aliases + +``` +ls, list +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-app-rm.mdx b/docs/reference/replicated-cli-app-rm.mdx index cfeb71d225..010caf6886 100644 --- a/docs/reference/replicated-cli-app-rm.mdx +++ b/docs/reference/replicated-cli-app-rm.mdx @@ -15,6 +15,12 @@ Use this command with caution as there is no way to undo this operation. replicated app rm NAME [flags] ``` +### Aliases + +``` +rm, delete +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-channel-demote.mdx b/docs/reference/replicated-cli-channel-demote.mdx new file mode 100644 index 0000000000..6c9e8ab10c --- /dev/null +++ b/docs/reference/replicated-cli-channel-demote.mdx @@ -0,0 +1,44 @@ +# replicated channel demote + +Demote a release from a channel + +### Synopsis + +Demote a channel release from a channel using a channel sequence or release sequence. + +``` +replicated channel demote CHANNEL_ID_OR_NAME [flags] +``` + +### Examples + +``` + # Demote a release from a channel by channel sequence + replicated channel release demote Beta --channel-sequence 15 + + # Demote a release from a channel by release sequence + replicated channel release demote Beta --release-sequence 12 +``` + +### Options + +``` + --channel-sequence int The channel sequence to demote + -h, --help help for demote + --release-sequence int The release sequence to demote +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel-ls.mdx b/docs/reference/replicated-cli-channel-ls.mdx index 85df3510ff..61c7a07036 100644 --- a/docs/reference/replicated-cli-channel-ls.mdx +++ b/docs/reference/replicated-cli-channel-ls.mdx @@ -10,6 +10,12 @@ List all channels in your app replicated channel ls [flags] ``` +### Aliases + +``` +ls, list +``` + ### Options ``` diff --git a/docs/reference/replicated-cli-channel-rm.mdx b/docs/reference/replicated-cli-channel-rm.mdx index dc111b28d2..1f5e7931d4 100644 --- a/docs/reference/replicated-cli-channel-rm.mdx +++ b/docs/reference/replicated-cli-channel-rm.mdx @@ -10,6 +10,12 @@ Remove (archive) a channel replicated channel rm CHANNEL_ID [flags] ``` +### Aliases + +``` +rm, delete +``` + ### Options ``` diff --git a/docs/reference/replicated-cli-channel-un-demote.mdx b/docs/reference/replicated-cli-channel-un-demote.mdx new file mode 100644 index 0000000000..b4d58c2341 --- /dev/null +++ b/docs/reference/replicated-cli-channel-un-demote.mdx @@ -0,0 +1,44 @@ +# replicated channel un-demote + +Un-demote a release from a channel + +### Synopsis + +Un-demote a channel release from a channel using a channel sequence or release sequence. + +``` +replicated channel un-demote CHANNEL_ID_OR_NAME [flags] +``` + +### Examples + +``` + # Un-demote a release from a channel by channel sequence + replicated channel release un-demote Beta --channel-sequence 15 + + # Un-demote a release from a channel by release sequence + replicated channel release un-demote Beta --release-sequence 12 +``` + +### Options + +``` + --channel-sequence int The channel sequence to un-demote + -h, --help help for un-demote + --release-sequence int The release sequence to un-demote +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel.mdx b/docs/reference/replicated-cli-channel.mdx index 0a246939cd..bc65fd6634 100644 --- a/docs/reference/replicated-cli-channel.mdx +++ b/docs/reference/replicated-cli-channel.mdx @@ -25,10 +25,12 @@ List channels * [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated * [replicated channel create](replicated-cli-channel-create) - Create a new channel in your app +* [replicated channel demote](replicated-cli-channel-demote) - Demote a release from a channel * [replicated channel disable-semantic-versioning](replicated-cli-channel-disable-semantic-versioning) - Disable semantic versioning for CHANNEL_ID * [replicated channel enable-semantic-versioning](replicated-cli-channel-enable-semantic-versioning) - Enable semantic versioning for CHANNEL_ID * [replicated channel inspect](replicated-cli-channel-inspect) - Show full details for a channel * [replicated channel ls](replicated-cli-channel-ls) - List all channels in your app * [replicated channel rm](replicated-cli-channel-rm) - Remove (archive) a channel +* [replicated channel un-demote](replicated-cli-channel-un-demote) - Un-demote a release from a channel ###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-addon-ls.mdx b/docs/reference/replicated-cli-cluster-addon-ls.mdx index 944b31dc8f..b13ab08db8 100644 --- a/docs/reference/replicated-cli-cluster-addon-ls.mdx +++ b/docs/reference/replicated-cli-cluster-addon-ls.mdx @@ -12,6 +12,12 @@ This can be useful for monitoring the health and configuration of add-ons or per replicated cluster addon ls CLUSTER_ID [flags] ``` +### Aliases + +``` +ls, list +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-cluster-addon-rm.mdx b/docs/reference/replicated-cli-cluster-addon-rm.mdx index ab9671c6e4..1b95f39a28 100644 --- a/docs/reference/replicated-cli-cluster-addon-rm.mdx +++ b/docs/reference/replicated-cli-cluster-addon-rm.mdx @@ -12,6 +12,12 @@ This command is useful when you want to deprovision an add-on that is no longer replicated cluster addon rm CLUSTER_ID --id ADDON_ID [flags] ``` +### Aliases + +``` +rm, delete +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-cluster-ls.mdx b/docs/reference/replicated-cli-cluster-ls.mdx index cd20bda8d1..69b3a26db6 100644 --- a/docs/reference/replicated-cli-cluster-ls.mdx +++ b/docs/reference/replicated-cli-cluster-ls.mdx @@ -14,6 +14,12 @@ Clusters that have been deleted will be shown with a 'deleted' status. replicated cluster ls [flags] ``` +### Aliases + +``` +ls, list +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx index 7ed5e9dd92..784734543e 100644 --- a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx +++ b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx @@ -14,6 +14,12 @@ You must provide the cluster ID to list its node groups. replicated cluster nodegroup ls [ID] [flags] ``` +### Aliases + +``` +ls, list +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-cluster-port-ls.mdx b/docs/reference/replicated-cli-cluster-port-ls.mdx index 8d84c30c56..c7402dc20a 100644 --- a/docs/reference/replicated-cli-cluster-port-ls.mdx +++ b/docs/reference/replicated-cli-cluster-port-ls.mdx @@ -12,6 +12,12 @@ This command is useful for viewing the current port configurations, protocols, a replicated cluster port ls CLUSTER_ID [flags] ``` +### Aliases + +``` +ls, list +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-cluster-port-rm.mdx b/docs/reference/replicated-cli-cluster-port-rm.mdx index 0c7420952c..7e2c6593d9 100644 --- a/docs/reference/replicated-cli-cluster-port-rm.mdx +++ b/docs/reference/replicated-cli-cluster-port-rm.mdx @@ -14,6 +14,12 @@ Note that you can only use either the port ID or port number when removing a por replicated cluster port rm CLUSTER_ID --id PORT_ID [flags] ``` +### Aliases + +``` +rm, delete +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-cluster-rm.mdx b/docs/reference/replicated-cli-cluster-rm.mdx index a4693c42e3..da8b2f6d9c 100644 --- a/docs/reference/replicated-cli-cluster-rm.mdx +++ b/docs/reference/replicated-cli-cluster-rm.mdx @@ -16,6 +16,12 @@ You cannot mix the use of cluster IDs with other options like removing by name, replicated cluster rm ID [ID …] [flags] ``` +### Aliases + +``` +rm, delete +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-customer-ls.mdx b/docs/reference/replicated-cli-customer-ls.mdx index 5284abc3ce..ea6d34c5d9 100644 --- a/docs/reference/replicated-cli-customer-ls.mdx +++ b/docs/reference/replicated-cli-customer-ls.mdx @@ -18,6 +18,12 @@ The command requires an app to be set using the --app flag. replicated customer ls [flags] ``` +### Aliases + +``` +ls, list +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-installer-ls.mdx b/docs/reference/replicated-cli-installer-ls.mdx index 1011b3f690..0247e67171 100644 --- a/docs/reference/replicated-cli-installer-ls.mdx +++ b/docs/reference/replicated-cli-installer-ls.mdx @@ -10,6 +10,12 @@ List an app's https://kurl.sh Kubernetes Installers replicated installer ls [flags] ``` +### Aliases + +``` +ls, list +``` + ### Options ``` diff --git a/docs/reference/replicated-cli-instance-ls.mdx b/docs/reference/replicated-cli-instance-ls.mdx index 4d4aaf41bf..c84b46fb96 100644 --- a/docs/reference/replicated-cli-instance-ls.mdx +++ b/docs/reference/replicated-cli-instance-ls.mdx @@ -10,6 +10,12 @@ list customer instances replicated instance ls [flags] ``` +### Aliases + +``` +ls, list +``` + ### Options ``` diff --git a/docs/reference/replicated-cli-registry-ls.mdx b/docs/reference/replicated-cli-registry-ls.mdx index cdbf6d40de..11bf084456 100644 --- a/docs/reference/replicated-cli-registry-ls.mdx +++ b/docs/reference/replicated-cli-registry-ls.mdx @@ -10,6 +10,12 @@ list registries, or a single registry by name replicated registry ls [NAME] [flags] ``` +### Aliases + +``` +ls, list +``` + ### Options ``` diff --git a/docs/reference/replicated-cli-registry-rm.mdx b/docs/reference/replicated-cli-registry-rm.mdx index 0875d7af70..3972dea851 100644 --- a/docs/reference/replicated-cli-registry-rm.mdx +++ b/docs/reference/replicated-cli-registry-rm.mdx @@ -10,6 +10,12 @@ remove registry by endpoint replicated registry rm [ENDPOINT] [flags] ``` +### Aliases + +``` +rm, delete +``` + ### Options ``` diff --git a/docs/reference/replicated-cli-release-ls.mdx b/docs/reference/replicated-cli-release-ls.mdx index 18d8f5e78b..199f28fedc 100644 --- a/docs/reference/replicated-cli-release-ls.mdx +++ b/docs/reference/replicated-cli-release-ls.mdx @@ -10,6 +10,12 @@ List all of an app's releases replicated release ls [flags] ``` +### Aliases + +``` +ls, list +``` + ### Options ``` diff --git a/docs/reference/replicated-cli-vm-ls.mdx b/docs/reference/replicated-cli-vm-ls.mdx index b3b7e98960..88c27ae412 100644 --- a/docs/reference/replicated-cli-vm-ls.mdx +++ b/docs/reference/replicated-cli-vm-ls.mdx @@ -16,6 +16,12 @@ The command also allows you to customize the output format, supporting 'json', ' replicated vm ls [flags] ``` +### Aliases + +``` +ls, list +``` + ### Examples ``` diff --git a/docs/reference/replicated-cli-vm-rm.mdx b/docs/reference/replicated-cli-vm-rm.mdx index 9bedd6e8f9..3712cd62dd 100644 --- a/docs/reference/replicated-cli-vm-rm.mdx +++ b/docs/reference/replicated-cli-vm-rm.mdx @@ -14,6 +14,12 @@ You can also use the '--dry-run' flag to simulate the removal without actually d replicated vm rm ID [ID …] [flags] ``` +### Aliases + +``` +rm, delete +``` + ### Examples ``` diff --git a/sidebars.js b/sidebars.js index 610f45afcf..2130bc6256 100644 --- a/sidebars.js +++ b/sidebars.js @@ -612,8 +612,7 @@ const sidebars = { { type: 'category', label: 'Replicated CLI', // This label is generated. Do not edit. - items: [ - // This list is generated. Do not edit. + items: [ // This list is generated. Do not edit. 'reference/replicated-cli-installing', 'reference/replicated', 'reference/replicated-cli-api', @@ -627,11 +626,13 @@ const sidebars = { 'reference/replicated-cli-app-rm', 'reference/replicated-cli-channel', 'reference/replicated-cli-channel-create', + 'reference/replicated-cli-channel-demote', 'reference/replicated-cli-channel-disable-semantic-versioning', 'reference/replicated-cli-channel-enable-semantic-versioning', 'reference/replicated-cli-channel-inspect', 'reference/replicated-cli-channel-ls', 'reference/replicated-cli-channel-rm', + 'reference/replicated-cli-channel-un-demote', 'reference/replicated-cli-cluster', 'reference/replicated-cli-cluster-addon', 'reference/replicated-cli-cluster-addon-create',