Skip to content

Commit 08135d9

Browse files
authored
Merge pull request #3424 from replicatedhq/update-cli-docs-v0.110.0-2025-08-05-222224
Update Replicated CLI docs for v0.110.0
2 parents 55a7a6c + e18b51a commit 08135d9

17 files changed

+111
-5
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# replicated release image ls
2+
3+
List images in a channel's current or specified release
4+
5+
### Synopsis
6+
7+
List all container images in the current release or a specific version of a channel
8+
9+
```
10+
replicated release image ls --channel CHANNEL_NAME_OR_ID [--version SEMVER] [--keep-proxy] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
# List images in current release of a channel by name
17+
replicated release image ls --channel Stable
18+
19+
# List images in a specific version of a channel
20+
replicated release image ls --channel Stable --version 1.2.1
21+
22+
# List images in a channel by ID
23+
replicated release image ls --channel 2abc123
24+
25+
# Keep proxy registry domains in the image names
26+
replicated release image ls --channel Stable --keep-proxy
27+
```
28+
29+
### Options
30+
31+
```
32+
--channel string The channel name, slug, or ID (required)
33+
-h, --help help for ls
34+
--keep-proxy Keep proxy registry domain in image names instead of stripping it
35+
--version string The specific semver version to get images for (optional, defaults to current release)
36+
```
37+
38+
### Options inherited from parent commands
39+
40+
```
41+
--app string The app slug or app id to use in all calls
42+
--debug Enable debug output
43+
--token string The API token to use to access your app in the Vendor API
44+
```
45+
46+
### SEE ALSO
47+
48+
* [replicated release image](replicated-cli-release-image) - Manage release images
49+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# replicated release image
2+
3+
Manage release images
4+
5+
### Synopsis
6+
7+
Manage release images
8+
9+
### Options
10+
11+
```
12+
-h, --help help for image
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--app string The app slug or app id to use in all calls
19+
--debug Enable debug output
20+
--token string The API token to use to access your app in the Vendor API
21+
```
22+
23+
### SEE ALSO
24+
25+
* [replicated release](replicated-cli-release) - Manage app releases
26+
* [replicated release image ls](replicated-cli-release-image-ls) - List images in a channel's current or specified release
27+

docs/reference/replicated-cli-release.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The release command allows vendors to create, display, and promote their release
2626
* [replicated release compatibility](replicated-cli-release-compatibility) - Report release compatibility
2727
* [replicated release create](replicated-cli-release-create) - Create a new release
2828
* [replicated release download](replicated-cli-release-download) - Download application manifests for a release.
29+
* [replicated release image](replicated-cli-release-image) - Manage release images
2930
* [replicated release inspect](replicated-cli-release-inspect) - Long: information about a release
3031
* [replicated release lint](replicated-cli-release-lint) - Lint a directory of KOTS manifests
3132
* [replicated release ls](replicated-cli-release-ls) - List all of an app's releases

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ By default, the command provisions one VM, but you can customize the number of V
1212

1313
The command also supports a "--wait" flag to wait for the VMs to be ready before returning control, with a customizable timeout duration.
1414

15+
VMs are currently a beta feature.
16+
1517
```
1618
replicated vm create [flags]
1719
```

docs/reference/replicated-cli-vm-ls.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ You can use the '--watch' flag to monitor VMs continuously. This will refresh th
1212

1313
The command also allows you to customize the output format, supporting 'json', 'table', and 'wide' views for flexibility based on your needs.
1414

15+
VMs are currently a beta feature.
16+
1517
```
1618
replicated vm ls [flags]
1719
```

docs/reference/replicated-cli-vm-port-expose.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The 'vm port expose' command is used to expose a specified port on a vm to the p
88

99
This command supports different protocols including "http", "https", "ws", and "wss" for web traffic and web socket communication.
1010

11+
VMs are currently a beta feature.
12+
1113
```
1214
replicated vm port expose VM_ID_OR_NAME --port PORT [flags]
1315
```

docs/reference/replicated-cli-vm-port-ls.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The 'vm port ls' command lists all the ports configured for a specific vm. You m
88

99
This command is useful for viewing the current port configurations, protocols, and other related settings of your test vm. The output format can be customized to suit your needs, and the available formats include table, JSON, and wide views.
1010

11+
VMs are currently a beta feature.
12+
1113
```
1214
replicated vm port ls VM_ID_OR_NAME [flags]
1315
```

docs/reference/replicated-cli-vm-port-rm.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The 'vm port rm' command removes a specific port from a vm. You must provide the
88

99
This command is useful for managing the network settings of your test vms by allowing you to clean up unused or incorrect ports. After removing a port, the updated list of ports will be displayed.
1010

11+
VMs are currently a beta feature.
12+
1113
```
1214
replicated vm port rm VM_ID_OR_NAME --id PORT_ID [flags]
1315
```

docs/reference/replicated-cli-vm-port.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,19 @@ The 'vm port' command is a parent command for managing ports in a vm. It allows
88

99
This command provides flexibility for handling ports in various test vms, ensuring efficient management of vm networking settings.
1010

11+
VMs are currently a beta feature.
12+
1113
### Examples
1214

1315
```
1416
# List all exposed ports in a vm
15-
replicated vm port ls [VM_ID]
17+
replicated vm port ls VM_ID_OR_NAME
1618
1719
# Remove an exposed port from a vm
18-
replicated vm port rm [VM_ID] [PORT]
20+
replicated vm port rm VM_ID_OR_NAME --id PORT_ID
1921
2022
# Expose a new port in a vm
21-
replicated vm port expose [VM_ID] [PORT]
23+
replicated vm port expose VM_ID_OR_NAME --port PORT
2224
```
2325

2426
### Options

docs/reference/replicated-cli-vm-rm.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ When specifying a name that matches multiple VMs, all VMs with that name will be
1212

1313
You can also use the '--dry-run' flag to simulate the removal without actually deleting the VMs.
1414

15+
VMs are currently a beta feature.
16+
1517
```
1618
replicated vm rm ID_OR_NAME [ID_OR_NAME …] [flags]
1719
```

0 commit comments

Comments
 (0)