From df96b7f07116b2c0b631239798b8959f4d778ebf Mon Sep 17 00:00:00 2001 From: Replicated Release Pipeline Date: Thu, 11 Dec 2025 12:36:12 +0000 Subject: [PATCH] Update Replicated CLI docs for v0.123.0 --- .../replicated-cli-release-create.mdx | 15 +++++++++++ .../replicated-cli-release-download.mdx | 26 ++++++++++++++++--- 2 files changed, 37 insertions(+), 4 deletions(-) diff --git a/docs/reference/replicated-cli-release-create.mdx b/docs/reference/replicated-cli-release-create.mdx index 35945baf72..444075ab65 100644 --- a/docs/reference/replicated-cli-release-create.mdx +++ b/docs/reference/replicated-cli-release-create.mdx @@ -7,6 +7,21 @@ Create a new release Create a new release by providing application manifests for the next release in your sequence. + If no flags are provided, the command will automatically use the configuration from + .replicated file in the current directory (or parent directories). The config should + specify charts and manifests to include. Charts will be automatically packaged using + helm, and manifests will be collected using glob patterns. + + Example .replicated config: + appSlug: "my-app" + charts: + - path: ./chart + manifests: + - ./manifests/*.yaml + + With this config, simply run: + replicated release create --version 1.0.0 --promote Unstable + ``` replicated release create [flags] ``` diff --git a/docs/reference/replicated-cli-release-download.mdx b/docs/reference/replicated-cli-release-download.mdx index 84d4decddc..4f7809928f 100644 --- a/docs/reference/replicated-cli-release-download.mdx +++ b/docs/reference/replicated-cli-release-download.mdx @@ -4,25 +4,43 @@ Download application manifests for a release. ### Synopsis -Download application manifests for a release to a specified directory. +Download application manifests for a release to a specified file or directory. + +For KOTS applications: + - Downloads release as a .tgz file if no RELEASE_SEQUENCE specified + - Can specify --channel to download the current release from that channel + - Auto-generates filename as app-slug.tgz if --dest not provided For non-KOTS applications, this is equivalent to the 'release inspect' command. +If no app is specified via --app flag, the app slug will be loaded from the .replicated config file. + ``` -replicated release download RELEASE_SEQUENCE [flags] +replicated release download [RELEASE_SEQUENCE] [flags] ``` ### Examples ``` +# Download latest release as autoci.tgz +replicated release download + +# Download specific sequence +replicated release download 42 --dest my-release.tgz + +# Download current release from Unstable channel +replicated release download --channel Unstable + +# Download to directory (KOTS only with sequence) replicated release download 1 --dest ./manifests ``` ### Options ``` - -d, --dest string Directory to which release manifests should be downloaded - -h, --help help for download + -c, --channel string Download the current release from this channel (case sensitive) + -d, --dest string File or directory to which release should be downloaded. Auto-generated if not specified. + -h, --help help for download ``` ### Options inherited from parent commands