From e36d50d36555bad1fdad37c46bbbabb1ce3a3640 Mon Sep 17 00:00:00 2001 From: Replicated Release Pipeline Date: Fri, 12 Dec 2025 20:29:49 +0000 Subject: [PATCH] Update Replicated CLI docs for v0.124.0 --- .../replicated-cli-app-hostname-ls.mdx | 56 +++++++++++++++++++ .../reference/replicated-cli-app-hostname.mdx | 41 ++++++++++++++ docs/reference/replicated-cli-app.mdx | 1 + sidebars.js | 2 + 4 files changed, 100 insertions(+) create mode 100644 docs/reference/replicated-cli-app-hostname-ls.mdx create mode 100644 docs/reference/replicated-cli-app-hostname.mdx diff --git a/docs/reference/replicated-cli-app-hostname-ls.mdx b/docs/reference/replicated-cli-app-hostname-ls.mdx new file mode 100644 index 0000000000..c82cde7333 --- /dev/null +++ b/docs/reference/replicated-cli-app-hostname-ls.mdx @@ -0,0 +1,56 @@ +# replicated app hostname ls + +List custom hostnames for an application + +### Synopsis + +List all custom hostnames configured for an application. + +This command fetches and displays all custom hostname configurations including: +- Registry hostnames +- Proxy hostnames +- Download Portal hostnames +- Replicated App hostnames + +The app ID or slug can be provided via the --app flag or from the .replicated config file. + +``` +replicated app hostname ls [flags] +``` + +### Aliases + +``` +ls, list +``` + +### Examples + +``` +# List all custom hostnames for an app +replicated app hostname ls --app myapp + +# List hostnames and output as JSON +replicated app hostname ls --app myapp --output json +``` + +### Options + +``` + -h, --help help for ls + -o, --output string The output format to use. One of: json|table (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --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 app hostname](replicated-cli-app-hostname) - Manage custom hostnames for applications + diff --git a/docs/reference/replicated-cli-app-hostname.mdx b/docs/reference/replicated-cli-app-hostname.mdx new file mode 100644 index 0000000000..97910099bd --- /dev/null +++ b/docs/reference/replicated-cli-app-hostname.mdx @@ -0,0 +1,41 @@ +# replicated app hostname + +Manage custom hostnames for applications + +### Synopsis + +The hostname command allows you to manage custom hostnames for your application. + +This command provides subcommands for listing and viewing custom hostname configurations +including registry, proxy, download portal, and replicated app hostnames. + +### Examples + +``` +# List all custom hostnames for an app +replicated app hostname ls --app myapp + +# List hostnames and output as JSON +replicated app hostname ls --app myapp --output json +``` + +### Options + +``` + -h, --help help for hostname +``` + +### 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 app](replicated-cli-app) - Manage applications +* [replicated app hostname ls](replicated-cli-app-hostname-ls) - List custom hostnames for an application + diff --git a/docs/reference/replicated-cli-app.mdx b/docs/reference/replicated-cli-app.mdx index ebdd0dce81..10acaabe6c 100644 --- a/docs/reference/replicated-cli-app.mdx +++ b/docs/reference/replicated-cli-app.mdx @@ -50,6 +50,7 @@ replicated app ls --output json * [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated * [replicated app create](replicated-cli-app-create) - Create a new application +* [replicated app hostname](replicated-cli-app-hostname) - Manage custom hostnames for applications * [replicated app ls](replicated-cli-app-ls) - List applications * [replicated app rm](replicated-cli-app-rm) - Delete an application diff --git a/sidebars.js b/sidebars.js index d511a57aba..c47f5e56a2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -617,6 +617,8 @@ const sidebars = { 'reference/replicated-cli-api-put', 'reference/replicated-cli-app', 'reference/replicated-cli-app-create', + 'reference/replicated-cli-app-hostname', + 'reference/replicated-cli-app-hostname-ls', 'reference/replicated-cli-app-ls', 'reference/replicated-cli-app-rm', 'reference/replicated-cli-channel',