Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions docs/reference/replicated-cli-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ Manage applications

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

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

Use the various subcommands to:
- Create new applications
- List all existing applications
- View details of a specific application
- Update application settings
- Delete applications from your account

### Examples
Expand All @@ -26,14 +24,8 @@ replicated app ls
# Create a new application
replicated app create "My New App"

# View details of a specific application
replicated app inspect "My App Name"

# Delete an application
replicated app delete "App to Remove"

# Update an application's settings
replicated app update "My App" --channel stable
replicated app rm "app-slug"

# List applications with custom output format
replicated app ls --output json
Expand Down
47 changes: 24 additions & 23 deletions docs/reference/replicated-cli-customer-create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,29 +42,30 @@ replicated customer create --app myapp --name "Full Options Inc" --custom-id "FU
### Options

```
--airgap If set, the license will allow airgap installs.
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
--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.
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
--email string Email address of the customer that is to be created.
--embedded-cluster-download If set, the license will allow embedded cluster downloads.
--ensure-channel If set, channel will be created if it does not exist.
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
--geo-axis If set, the license will allow Geo Axis usage.
--gitops If set, the license will allow the GitOps usage.
--helm-install If set, the license will allow Helm installs.
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
-h, --help help for create
--identity-service If set, the license will allow Identity Service usage.
--installer-support If set, the license will allow installer support.
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
--kurl-install If set, the license will allow kURL installs.
--name string Name of the customer
-o, --output string The output format to use. One of: json|table (default "table")
--snapshot If set, the license will allow Snapshots.
--support-bundle-upload If set, the license will allow uploading support bundles.
--type string The license type to create. One of: dev|trial|paid|community|test (default: dev) (default "dev")
--airgap If set, the license will allow airgap installs.
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
--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.
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
--email string Email address of the customer that is to be created.
--embedded-cluster-download If set, the license will allow Embedded Cluster downloads.
--embedded-cluster-multinode If set, users can add nodes to Embedded Cluster instances. (default true)
--ensure-channel If set, channel will be created if it does not exist.
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
--geo-axis If set, the license will allow Geo Axis usage.
--gitops If set, the license will allow the GitOps usage.
--helm-install If set, the license will allow Helm installs.
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
-h, --help help for create
--identity-service If set, the license will allow Identity Service usage.
--installer-support If set, the license will allow installer support.
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
--kurl-install If set, the license will allow kURL installs.
--name string Name of the customer
-o, --output string The output format to use. One of: json|table (default "table")
--snapshot If set, the license will allow Snapshots.
--support-bundle-upload If set, the license will allow uploading support bundles.
--type string The license type to create. One of: dev|trial|paid|community|test (default: dev) (default "dev")
```

### Options inherited from parent commands
Expand Down
47 changes: 24 additions & 23 deletions docs/reference/replicated-cli-customer-update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,29 +41,30 @@ replicated customer update --customer cus_abcdef123456 --name "JSON Corp" --outp
### Options

```
--airgap If set, the license will allow airgap installs.
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
--customer string The ID of the customer to update
--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.
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
--email string Email address of the customer that is to be updated.
--embedded-cluster-download If set, the license will allow embedded cluster downloads.
--ensure-channel If set, channel will be created if it does not exist.
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
--geo-axis If set, the license will allow Geo Axis usage.
--gitops If set, the license will allow the GitOps usage.
--helm-install If set, the license will allow Helm installs.
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
-h, --help help for update
--identity-service If set, the license will allow Identity Service usage.
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
--kurl-install If set, the license will allow kURL installs.
--name string Name of the customer
-o, --output string The output format to use. One of: json|table (default "table")
--snapshot If set, the license will allow Snapshots.
--support-bundle-upload If set, the license will allow uploading support bundles.
--type string The license type to update. One of: dev|trial|paid|community|test (default: dev) (default "dev")
--airgap If set, the license will allow airgap installs.
--channel stringArray Release channel to which the customer should be assigned (can be specified multiple times)
--custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems
--customer string The ID of the customer to update
--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.
--developer-mode If set, Replicated SDK installed in dev mode will use mock data.
--email string Email address of the customer that is to be updated.
--embedded-cluster-download If set, the license will allow Embedded Cluster downloads.
--embedded-cluster-multinode If set, users can add nodes to Embedded Cluster instances. (default true)
--ensure-channel If set, channel will be created if it does not exist.
--expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m'
--geo-axis If set, the license will allow Geo Axis usage.
--gitops If set, the license will allow the GitOps usage.
--helm-install If set, the license will allow Helm installs.
--helmvm-cluster-download If set, the license will allow helmvm cluster downloads.
-h, --help help for update
--identity-service If set, the license will allow Identity Service usage.
--kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true)
--kurl-install If set, the license will allow kURL installs.
--name string Name of the customer
-o, --output string The output format to use. One of: json|table (default "table")
--snapshot If set, the license will allow Snapshots.
--support-bundle-upload If set, the license will allow uploading support bundles.
--type string The license type to update. One of: dev|trial|paid|community|test (default: dev) (default "dev")
```

### Options inherited from parent commands
Expand Down
65 changes: 0 additions & 65 deletions docs/reference/replicated-cli-vm-scp.mdx

This file was deleted.

39 changes: 39 additions & 0 deletions docs/reference/replicated-cli-vm-ssh-endpoint.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# replicated vm ssh-endpoint

Get the SSH endpoint of a VM

### Synopsis

Get the SSH endpoint and port of a VM.

The output will be in the format: hostname:port

```
replicated vm ssh-endpoint VM_ID [flags]
```

### Examples

```
# Get SSH endpoint for a specific VM by ID
replicated vm ssh-endpoint <id>
```

### Options

```
-h, --help help for ssh-endpoint
```

### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--debug Enable debug output
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated vm](replicated-cli-vm) - Manage test virtual machines.

54 changes: 0 additions & 54 deletions docs/reference/replicated-cli-vm-ssh.mdx

This file was deleted.

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

3 changes: 1 addition & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -722,8 +722,7 @@ const sidebars = {
'reference/replicated-cli-vm-port-ls',
'reference/replicated-cli-vm-port-rm',
'reference/replicated-cli-vm-rm',
'reference/replicated-cli-vm-scp',
'reference/replicated-cli-vm-ssh',
'reference/replicated-cli-vm-ssh-endpoint',
'reference/replicated-cli-vm-update',
'reference/replicated-cli-vm-update-ttl',
'reference/replicated-cli-vm-versions',
Expand Down