Skip to content

Commit d905af9

Browse files
divolginReplicated Release Pipeline
divolgin
and
Replicated Release Pipeline
authored
Update Replicated CLI docs for v0.101.1 (#3199)
Co-authored-by: Replicated Release Pipeline <release@replicated.com>
1 parent 81eaa85 commit d905af9

8 files changed

+92
-180
lines changed

‎docs/reference/replicated-cli-app.mdx

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@ Manage applications
66

77
The app command allows you to manage applications in your Replicated account.
88

9-
This command provides a suite of subcommands for creating, listing, updating, and
9+
This command provides a suite of subcommands for creating, listing, and
1010
deleting applications. You can perform operations such as creating new apps,
11-
viewing app details, modifying app settings, and removing apps from your account.
11+
viewing app details, and removing apps from your account.
1212

1313
Use the various subcommands to:
1414
- Create new applications
1515
- List all existing applications
16-
- View details of a specific application
17-
- Update application settings
1816
- Delete applications from your account
1917

2018
### Examples
@@ -26,14 +24,8 @@ replicated app ls
2624
# Create a new application
2725
replicated app create "My New App"
2826
29-
# View details of a specific application
30-
replicated app inspect "My App Name"
31-
3227
# Delete an application
33-
replicated app delete "App to Remove"
34-
35-
# Update an application's settings
36-
replicated app update "My App" --channel stable
28+
replicated app rm "app-slug"
3729
3830
# List applications with custom output format
3931
replicated app ls --output json

‎docs/reference/replicated-cli-customer-create.mdx

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -42,29 +42,30 @@ replicated customer create --app myapp --name "Full Options Inc" --custom-id "FU
4242
### Options
4343

4444
```
45-
--airgap If set, the license will allow airgap installs.
46-
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
47-
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
48-
--default-channel string Which of the specified channels should be the default channel. if not set, the first channel specified will be the default channel.
49-
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
50-
--email string Email address of the customer that is to be created.
51-
--embedded-cluster-download If set, the license will allow embedded cluster downloads.
52-
--ensure-channel If set, channel will be created if it does not exist.
53-
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
54-
--geo-axis If set, the license will allow Geo Axis usage.
55-
--gitops If set, the license will allow the GitOps usage.
56-
--helm-install If set, the license will allow Helm installs.
57-
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
58-
-h, --help help for create
59-
--identity-service If set, the license will allow Identity Service usage.
60-
--installer-support If set, the license will allow installer support.
61-
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
62-
--kurl-install If set, the license will allow kURL installs.
63-
--name string Name of the customer
64-
-o, --output string The output format to use. One of: json|table (default "table")
65-
--snapshot If set, the license will allow Snapshots.
66-
--support-bundle-upload If set, the license will allow uploading support bundles.
67-
--type string The license type to create. One of: dev|trial|paid|community|test (default: dev) (default "dev")
45+
--airgap If set, the license will allow airgap installs.
46+
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
47+
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
48+
--default-channel string Which of the specified channels should be the default channel. if not set, the first channel specified will be the default channel.
49+
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
50+
--email string Email address of the customer that is to be created.
51+
--embedded-cluster-download If set, the license will allow Embedded Cluster downloads.
52+
--embedded-cluster-multinode If set, users can add nodes to Embedded Cluster instances. (default true)
53+
--ensure-channel If set, channel will be created if it does not exist.
54+
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
55+
--geo-axis If set, the license will allow Geo Axis usage.
56+
--gitops If set, the license will allow the GitOps usage.
57+
--helm-install If set, the license will allow Helm installs.
58+
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
59+
-h, --help help for create
60+
--identity-service If set, the license will allow Identity Service usage.
61+
--installer-support If set, the license will allow installer support.
62+
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
63+
--kurl-install If set, the license will allow kURL installs.
64+
--name string Name of the customer
65+
-o, --output string The output format to use. One of: json|table (default "table")
66+
--snapshot If set, the license will allow Snapshots.
67+
--support-bundle-upload If set, the license will allow uploading support bundles.
68+
--type string The license type to create. One of: dev|trial|paid|community|test (default: dev) (default "dev")
6869
```
6970

7071
### Options inherited from parent commands

‎docs/reference/replicated-cli-customer-update.mdx

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,30 @@ replicated customer update --customer cus_abcdef123456 --name "JSON Corp" --outp
4141
### Options
4242

4343
```
44-
--airgap If set, the license will allow airgap installs.
45-
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
46-
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
47-
--customer string The ID of the customer to update
48-
--default-channel string Which of the specified channels should be the default channel. if not set, the first channel specified will be the default channel.
49-
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
50-
--email string Email address of the customer that is to be updated.
51-
--embedded-cluster-download If set, the license will allow embedded cluster downloads.
52-
--ensure-channel If set, channel will be created if it does not exist.
53-
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
54-
--geo-axis If set, the license will allow Geo Axis usage.
55-
--gitops If set, the license will allow the GitOps usage.
56-
--helm-install If set, the license will allow Helm installs.
57-
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
58-
-h, --help help for update
59-
--identity-service If set, the license will allow Identity Service usage.
60-
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
61-
--kurl-install If set, the license will allow kURL installs.
62-
--name string Name of the customer
63-
-o, --output string The output format to use. One of: json|table (default "table")
64-
--snapshot If set, the license will allow Snapshots.
65-
--support-bundle-upload If set, the license will allow uploading support bundles.
66-
--type string The license type to update. One of: dev|trial|paid|community|test (default: dev) (default "dev")
44+
--airgap If set, the license will allow airgap installs.
45+
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
46+
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
47+
--customer string The ID of the customer to update
48+
--default-channel string Which of the specified channels should be the default channel. if not set, the first channel specified will be the default channel.
49+
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
50+
--email string Email address of the customer that is to be updated.
51+
--embedded-cluster-download If set, the license will allow Embedded Cluster downloads.
52+
--embedded-cluster-multinode If set, users can add nodes to Embedded Cluster instances. (default true)
53+
--ensure-channel If set, channel will be created if it does not exist.
54+
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
55+
--geo-axis If set, the license will allow Geo Axis usage.
56+
--gitops If set, the license will allow the GitOps usage.
57+
--helm-install If set, the license will allow Helm installs.
58+
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
59+
-h, --help help for update
60+
--identity-service If set, the license will allow Identity Service usage.
61+
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
62+
--kurl-install If set, the license will allow kURL installs.
63+
--name string Name of the customer
64+
-o, --output string The output format to use. One of: json|table (default "table")
65+
--snapshot If set, the license will allow Snapshots.
66+
--support-bundle-upload If set, the license will allow uploading support bundles.
67+
--type string The license type to update. One of: dev|trial|paid|community|test (default: dev) (default "dev")
6768
```
6869

6970
### Options inherited from parent commands

‎docs/reference/replicated-cli-vm-scp.mdx

Lines changed: 0 additions & 65 deletions
This file was deleted.

‎docs/reference/replicated-cli-vm-ssh-endpoint.mdx

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# replicated vm ssh-endpoint
2+
3+
Get the SSH endpoint of a VM
4+
5+
### Synopsis
6+
7+
Get the SSH endpoint and port of a VM.
8+
9+
The output will be in the format: hostname:port
10+
11+
```
12+
replicated vm ssh-endpoint VM_ID [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
# Get SSH endpoint for a specific VM by ID
19+
replicated vm ssh-endpoint <id>
20+
```
21+
22+
### Options
23+
24+
```
25+
-h, --help help for ssh-endpoint
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
--app string The app slug or app id to use in all calls
32+
--debug Enable debug output
33+
--token string The API token to use to access your app in the Vendor API
34+
```
35+
36+
### SEE ALSO
37+
38+
* [replicated vm](replicated-cli-vm) - Manage test virtual machines.
39+

‎docs/reference/replicated-cli-vm-ssh.mdx

Lines changed: 0 additions & 54 deletions
This file was deleted.

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ replicated vm update ttl <vm-id> --ttl 24h
4343
* [replicated vm ls](replicated-cli-vm-ls) - List test VMs and their status, with optional filters for start/end time and terminated VMs.
4444
* [replicated vm port](replicated-cli-vm-port) - Manage VM ports.
4545
* [replicated vm rm](replicated-cli-vm-rm) - Remove test VM(s) immediately, with options to filter by name, tag, or remove all VMs.
46-
* [replicated vm scp](replicated-cli-vm-scp) - Copy files to/from a VM
47-
* [replicated vm ssh](replicated-cli-vm-ssh) - SSH into a VM
46+
* [replicated vm ssh-endpoint](replicated-cli-vm-ssh-endpoint) - Get the SSH endpoint of a VM
4847
* [replicated vm update](replicated-cli-vm-update) - Update VM settings.
4948
* [replicated vm versions](replicated-cli-vm-versions) - List available VM versions.
5049

‎sidebars.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -722,8 +722,7 @@ const sidebars = {
722722
'reference/replicated-cli-vm-port-ls',
723723
'reference/replicated-cli-vm-port-rm',
724724
'reference/replicated-cli-vm-rm',
725-
'reference/replicated-cli-vm-scp',
726-
'reference/replicated-cli-vm-ssh',
725+
'reference/replicated-cli-vm-ssh-endpoint',
727726
'reference/replicated-cli-vm-update',
728727
'reference/replicated-cli-vm-update-ttl',
729728
'reference/replicated-cli-vm-versions',

0 commit comments

Comments
 (0)