Skip to content

Commit 12d2104

Browse files
authored
docs: Wrap runpodctl command synopses in RequestExample components (#460)
2 parents a903546 + 62b64cd commit 12d2104

15 files changed

+45
-18
lines changed

runpodctl/reference/runpodctl-config.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "config"
55

66
Configure the Runpod CLI with your API credentials and API URL to enable programmatic access to your Runpod resources.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl config [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-create-pod.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "create pod"
55

66
Create and start a new Pod on Runpod with configuration options for GPU type, storage, networking, and cloud tier.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl create pod [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-create-pods.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "create pods"
55

66
Create multiple Pods at once with identical configurations (useful for parallel workloads or distributed training).
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl create pods [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-get-cloud.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "get cloud"
55

66
List all GPUs currently available in the Runpod cloud, with options for filtering by GPU count, memory/disk size, and cloud type.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl get cloud <gpuCount> [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-get-pod.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "get pod"
55

66
List all your Pods or retrieve details about a specific Pod by its ID.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl get pod <podId> [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-receive.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "receive"
55

66
Receive files or folders sent from another machine using a secure peer-to-peer connection established with a connection code.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl receive <code> [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-remove-pod.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "remove pod"
55

66
Permanently delete a Pod and all its associated data. This action cannot be undone.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl remove pod <podId>
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-remove-pods.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "remove pods"
55

66
Terminate multiple Pods that share the same name. This is useful for cleaning up groups of Pods created with the `create pods` command.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl remove pods <name> [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-send.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "send"
55

66
Transfer files or folders from your local machine to a Pod or another computer using a secure peer-to-peer connection.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl send <fileOrFolder> [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

runpodctl/reference/runpodctl-ssh-add-key.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebarTitle: "ssh add-key"
55

66
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.
77

8-
```sh
8+
<RequestExample>
9+
```sh Command
910
runpodctl ssh add-key [flags]
1011
```
12+
</RequestExample>
1113

1214
## Example
1315

0 commit comments

Comments
 (0)