diff --git a/docs/reference/replicated-cli-app.mdx b/docs/reference/replicated-cli-app.mdx index ea70904690..614c06d130 100644 --- a/docs/reference/replicated-cli-app.mdx +++ b/docs/reference/replicated-cli-app.mdx @@ -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 @@ -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 diff --git a/docs/reference/replicated-cli-customer-create.mdx b/docs/reference/replicated-cli-customer-create.mdx index 8c7f2ddd72..7583d2615a 100644 --- a/docs/reference/replicated-cli-customer-create.mdx +++ b/docs/reference/replicated-cli-customer-create.mdx @@ -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 diff --git a/docs/reference/replicated-cli-customer-update.mdx b/docs/reference/replicated-cli-customer-update.mdx index a4f2d2219c..ab98a2b4a3 100644 --- a/docs/reference/replicated-cli-customer-update.mdx +++ b/docs/reference/replicated-cli-customer-update.mdx @@ -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 diff --git a/docs/reference/replicated-cli-vm-scp.mdx b/docs/reference/replicated-cli-vm-scp.mdx deleted file mode 100644 index 0215869c92..0000000000 --- a/docs/reference/replicated-cli-vm-scp.mdx +++ /dev/null @@ -1,65 +0,0 @@ -# replicated vm scp - -Copy files to/from a VM - -### Synopsis - -Securely copy files to or from a VM using SCP. - -This command allows you to copy files between your local machine and a VM. You can specify the VM ID followed by a colon and the path on the VM, or just a local path. - -To copy a file from your local machine to a VM, use: -replicated vm scp localfile.txt vm-id:/path/on/vm/ - -To copy a file from a VM to your local machine, use: -replicated vm scp vm-id:/path/on/vm/file.txt localfile.txt - -If no VM ID is provided and multiple VMs are available, you will be prompted to select a VM. - -The SSH user can be specified in order of precedence: -1. By specifying the -u flag -2. REPLICATED_SSH_USER environment variable -3. GITHUB_ACTOR environment variable (from GitHub Actions) -4. GITHUB_USER environment variable - -Note: Only running VMs can be connected to via SCP. - -``` -replicated vm scp [VM_ID:]SOURCE [VM_ID:]DESTINATION [flags] -``` - -### Examples - -``` -# Copy a local file to a VM -replicated vm scp localfile.txt vm-id:/home/user/ - -# Copy a file from a VM to local machine -replicated vm scp vm-id:/home/user/file.txt localfile.txt - -# Copy with a specific user -replicated vm scp -u myuser localfile.txt vm-id:/home/myuser/ - -# Interactive VM selection (if VM ID is not specified) -replicated vm scp localfile.txt :/home/user/ -``` - -### Options - -``` - -h, --help help for scp - -u, --user string SSH user to connect with -``` - -### 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. - diff --git a/docs/reference/replicated-cli-vm-ssh-endpoint.mdx b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx new file mode 100644 index 0000000000..d0a9aa8757 --- /dev/null +++ b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx @@ -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 +``` + +### 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. + diff --git a/docs/reference/replicated-cli-vm-ssh.mdx b/docs/reference/replicated-cli-vm-ssh.mdx deleted file mode 100644 index d405b3cf3c..0000000000 --- a/docs/reference/replicated-cli-vm-ssh.mdx +++ /dev/null @@ -1,54 +0,0 @@ -# replicated vm ssh - -SSH into a VM - -### Synopsis - -Connect to a VM using SSH. - -If a VM ID is provided, it will directly connect to that VM. Otherwise, if multiple VMs are available, you will be prompted to select the VM you want to connect to. The command will then establish an SSH connection to the selected VM using the appropriate credentials and configuration. - -The SSH user can be specified in order of precedence: -1. By specifying the -u flag -2. REPLICATED_SSH_USER environment variable -3. GITHUB_ACTOR environment variable (from GitHub Actions) -4. GITHUB_USER environment variable - -Note: Only running VMs can be connected to via SSH. - -``` -replicated vm ssh [VM_ID] [flags] -``` - -### Examples - -``` -# SSH into a specific VM by ID -replicated vm ssh - -# SSH into a VM with a specific user -replicated vm ssh -u myuser - -# SSH into a VM (interactive selection if multiple VMs exist) -replicated vm ssh -``` - -### Options - -``` - -h, --help help for ssh - -u, --user string SSH user to connect with -``` - -### 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. - diff --git a/docs/reference/replicated-cli-vm.mdx b/docs/reference/replicated-cli-vm.mdx index 6d0b6cb93c..afde0fe68b 100644 --- a/docs/reference/replicated-cli-vm.mdx +++ b/docs/reference/replicated-cli-vm.mdx @@ -43,8 +43,7 @@ replicated vm update ttl --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. diff --git a/sidebars.js b/sidebars.js index ff97152b97..ff4a157417 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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',