From 62b64cde21d315b05d024af37460b1f00dde05eb Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Wed, 19 Nov 2025 16:24:34 +0000 Subject: [PATCH] Wrap runpodctl command synopses in RequestExample components --- runpodctl/reference/runpodctl-config.mdx | 4 +++- runpodctl/reference/runpodctl-create-pod.mdx | 4 +++- runpodctl/reference/runpodctl-create-pods.mdx | 4 +++- runpodctl/reference/runpodctl-get-cloud.mdx | 4 +++- runpodctl/reference/runpodctl-get-pod.mdx | 4 +++- runpodctl/reference/runpodctl-receive.mdx | 4 +++- runpodctl/reference/runpodctl-remove-pod.mdx | 4 +++- runpodctl/reference/runpodctl-remove-pods.mdx | 4 +++- runpodctl/reference/runpodctl-send.mdx | 4 +++- runpodctl/reference/runpodctl-ssh-add-key.mdx | 4 +++- runpodctl/reference/runpodctl-ssh-list-keys.mdx | 4 +++- runpodctl/reference/runpodctl-start-pod.mdx | 4 +++- runpodctl/reference/runpodctl-stop-pod.mdx | 4 +++- runpodctl/reference/runpodctl-update.mdx | 5 +++-- runpodctl/reference/runpodctl-version.mdx | 6 +++--- 15 files changed, 45 insertions(+), 18 deletions(-) diff --git a/runpodctl/reference/runpodctl-config.mdx b/runpodctl/reference/runpodctl-config.mdx index 9d464c98..2c383e3f 100644 --- a/runpodctl/reference/runpodctl-config.mdx +++ b/runpodctl/reference/runpodctl-config.mdx @@ -5,9 +5,11 @@ sidebarTitle: "config" Configure the Runpod CLI with your API credentials and API URL to enable programmatic access to your Runpod resources. -```sh + +```sh Command runpodctl config [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-create-pod.mdx b/runpodctl/reference/runpodctl-create-pod.mdx index 5f193649..315e4816 100644 --- a/runpodctl/reference/runpodctl-create-pod.mdx +++ b/runpodctl/reference/runpodctl-create-pod.mdx @@ -5,9 +5,11 @@ sidebarTitle: "create pod" Create and start a new Pod on Runpod with configuration options for GPU type, storage, networking, and cloud tier. -```sh + +```sh Command runpodctl create pod [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-create-pods.mdx b/runpodctl/reference/runpodctl-create-pods.mdx index 301e64ec..4f88a0fd 100644 --- a/runpodctl/reference/runpodctl-create-pods.mdx +++ b/runpodctl/reference/runpodctl-create-pods.mdx @@ -5,9 +5,11 @@ sidebarTitle: "create pods" Create multiple Pods at once with identical configurations (useful for parallel workloads or distributed training). -```sh + +```sh Command runpodctl create pods [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-get-cloud.mdx b/runpodctl/reference/runpodctl-get-cloud.mdx index 51b60f15..3d82af50 100644 --- a/runpodctl/reference/runpodctl-get-cloud.mdx +++ b/runpodctl/reference/runpodctl-get-cloud.mdx @@ -5,9 +5,11 @@ sidebarTitle: "get cloud" List all GPUs currently available in the Runpod cloud, with options for filtering by GPU count, memory/disk size, and cloud type. -```sh + +```sh Command runpodctl get cloud [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-get-pod.mdx b/runpodctl/reference/runpodctl-get-pod.mdx index ce44fe32..ea6754c5 100644 --- a/runpodctl/reference/runpodctl-get-pod.mdx +++ b/runpodctl/reference/runpodctl-get-pod.mdx @@ -5,9 +5,11 @@ sidebarTitle: "get pod" List all your Pods or retrieve details about a specific Pod by its ID. -```sh + +```sh Command runpodctl get pod [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-receive.mdx b/runpodctl/reference/runpodctl-receive.mdx index 9611f8af..4823e901 100644 --- a/runpodctl/reference/runpodctl-receive.mdx +++ b/runpodctl/reference/runpodctl-receive.mdx @@ -5,9 +5,11 @@ sidebarTitle: "receive" Receive files or folders sent from another machine using a secure peer-to-peer connection established with a connection code. -```sh + +```sh Command runpodctl receive [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-remove-pod.mdx b/runpodctl/reference/runpodctl-remove-pod.mdx index 5b004564..ca214d29 100644 --- a/runpodctl/reference/runpodctl-remove-pod.mdx +++ b/runpodctl/reference/runpodctl-remove-pod.mdx @@ -5,9 +5,11 @@ sidebarTitle: "remove pod" Permanently delete a Pod and all its associated data. This action cannot be undone. -```sh + +```sh Command runpodctl remove pod ``` + ## Example diff --git a/runpodctl/reference/runpodctl-remove-pods.mdx b/runpodctl/reference/runpodctl-remove-pods.mdx index 0bea4a53..8de04940 100644 --- a/runpodctl/reference/runpodctl-remove-pods.mdx +++ b/runpodctl/reference/runpodctl-remove-pods.mdx @@ -5,9 +5,11 @@ sidebarTitle: "remove pods" Terminate multiple Pods that share the same name. This is useful for cleaning up groups of Pods created with the `create pods` command. -```sh + +```sh Command runpodctl remove pods [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-send.mdx b/runpodctl/reference/runpodctl-send.mdx index a4f5ce74..061f28b9 100644 --- a/runpodctl/reference/runpodctl-send.mdx +++ b/runpodctl/reference/runpodctl-send.mdx @@ -5,9 +5,11 @@ sidebarTitle: "send" Transfer files or folders from your local machine to a Pod or another computer using a secure peer-to-peer connection. -```sh + +```sh Command runpodctl send [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-ssh-add-key.mdx b/runpodctl/reference/runpodctl-ssh-add-key.mdx index 1f4c1f72..0af48ef2 100644 --- a/runpodctl/reference/runpodctl-ssh-add-key.mdx +++ b/runpodctl/reference/runpodctl-ssh-add-key.mdx @@ -5,9 +5,11 @@ sidebarTitle: "ssh add-key" Add an SSH public key to your Runpod account for secure Pod access. If no key is provided, a new key pair will be generated automatically. -```sh + +```sh Command runpodctl ssh add-key [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-ssh-list-keys.mdx b/runpodctl/reference/runpodctl-ssh-list-keys.mdx index 8e8c290e..c5cbd58b 100644 --- a/runpodctl/reference/runpodctl-ssh-list-keys.mdx +++ b/runpodctl/reference/runpodctl-ssh-list-keys.mdx @@ -5,9 +5,11 @@ sidebarTitle: "ssh list-keys" Display all SSH keys associated with your Runpod account. -```sh + +```sh Command runpodctl ssh list-keys [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-start-pod.mdx b/runpodctl/reference/runpodctl-start-pod.mdx index d3dc4b31..6b09d31d 100644 --- a/runpodctl/reference/runpodctl-start-pod.mdx +++ b/runpodctl/reference/runpodctl-start-pod.mdx @@ -5,9 +5,11 @@ sidebarTitle: "start pod" Start a stopped Pod, resuming compute and billing. Use this to restart Pods that were previously stopped. -```sh + +```sh Command runpodctl start pod [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-stop-pod.mdx b/runpodctl/reference/runpodctl-stop-pod.mdx index 1d98418c..4598959a 100644 --- a/runpodctl/reference/runpodctl-stop-pod.mdx +++ b/runpodctl/reference/runpodctl-stop-pod.mdx @@ -5,9 +5,11 @@ sidebarTitle: "stop pod" Stop a running Pod to pause compute operations. The Pod's persistent storage will be retained, but you'll continue to be charged for storage until the Pod is removed. -```sh + +```sh Command runpodctl stop pod [flags] ``` + ## Example diff --git a/runpodctl/reference/runpodctl-update.mdx b/runpodctl/reference/runpodctl-update.mdx index d182de36..be01ebbb 100644 --- a/runpodctl/reference/runpodctl-update.mdx +++ b/runpodctl/reference/runpodctl-update.mdx @@ -5,10 +5,11 @@ sidebarTitle: "update" Update `runpodctl` to the latest version to access new features and bug fixes. -```sh + +```sh Command runpodctl update ``` - + ## Related commands diff --git a/runpodctl/reference/runpodctl-version.mdx b/runpodctl/reference/runpodctl-version.mdx index 5101b5a3..4d7cf40e 100644 --- a/runpodctl/reference/runpodctl-version.mdx +++ b/runpodctl/reference/runpodctl-version.mdx @@ -5,11 +5,11 @@ sidebarTitle: "version" Display the current version of `runpodctl` installed on your system. -```sh + +```sh Command runpodctl version ``` - - + ## Related commands