Skip to content

Commit 040a0ca

Browse files
authored
Merge pull request #3710 from replicatedhq/update-cli-docs-v0.123.0-2025-12-11-123610
Update Replicated CLI docs for v0.123.0
2 parents 0ffeb89 + df96b7f commit 040a0ca

File tree

2 files changed

+37
-4
lines changed

2 files changed

+37
-4
lines changed

docs/reference/replicated-cli-release-create.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@ Create a new release
77
Create a new release by providing application manifests for the next release in
88
your sequence.
99

10+
If no flags are provided, the command will automatically use the configuration from
11+
.replicated file in the current directory (or parent directories). The config should
12+
specify charts and manifests to include. Charts will be automatically packaged using
13+
helm, and manifests will be collected using glob patterns.
14+
15+
Example .replicated config:
16+
appSlug: "my-app"
17+
charts:
18+
- path: ./chart
19+
manifests:
20+
- ./manifests/*.yaml
21+
22+
With this config, simply run:
23+
replicated release create --version 1.0.0 --promote Unstable
24+
1025
```
1126
replicated release create [flags]
1227
```

docs/reference/replicated-cli-release-download.mdx

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,43 @@ Download application manifests for a release.
44

55
### Synopsis
66

7-
Download application manifests for a release to a specified directory.
7+
Download application manifests for a release to a specified file or directory.
8+
9+
For KOTS applications:
10+
- Downloads release as a .tgz file if no RELEASE_SEQUENCE specified
11+
- Can specify --channel to download the current release from that channel
12+
- Auto-generates filename as app-slug.tgz if --dest not provided
813

914
For non-KOTS applications, this is equivalent to the 'release inspect' command.
1015

16+
If no app is specified via --app flag, the app slug will be loaded from the .replicated config file.
17+
1118
```
12-
replicated release download RELEASE_SEQUENCE [flags]
19+
replicated release download [RELEASE_SEQUENCE] [flags]
1320
```
1421

1522
### Examples
1623

1724
```
25+
# Download latest release as autoci.tgz
26+
replicated release download
27+
28+
# Download specific sequence
29+
replicated release download 42 --dest my-release.tgz
30+
31+
# Download current release from Unstable channel
32+
replicated release download --channel Unstable
33+
34+
# Download to directory (KOTS only with sequence)
1835
replicated release download 1 --dest ./manifests
1936
```
2037

2138
### Options
2239

2340
```
24-
-d, --dest string Directory to which release manifests should be downloaded
25-
-h, --help help for download
41+
-c, --channel string Download the current release from this channel (case sensitive)
42+
-d, --dest string File or directory to which release should be downloaded. Auto-generated if not specified.
43+
-h, --help help for download
2644
```
2745

2846
### Options inherited from parent commands

0 commit comments

Comments
 (0)