Skip to content

Rewrite runpodctl arguments and flags using ResponseField component #456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
muhsinking merged 2 commits into from
Nov 18, 2025
Merged

Rewrite runpodctl arguments and flags using ResponseField component #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
125f6df
Rewrite runpodctl arguments and flags using ResponseField component
promptless[bot] Nov 18, 2025
8548ba9
Improve code examples and integer defaults
muhsinking Nov 18, 2025
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
17 changes: 6 additions & 11 deletions runpodctl/reference/runpodctl-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,16 @@ runpodctl config [flags]
Configure the CLI with your API key:

```sh
runpodctl config --apiKey rpaPOIUYYULKDSALVIUT3Q2ZRKZ98IUYTSK2OQQ2CWQxkd01
runpodctl config \
--apiKey "rpaPOIUYYULKDSALVIUT3Q2ZRKZ98IUYTSK2OQQ2CWQxkd01"
```

## Flags

The following flags are available for the `config` command:

---

`--apiKey <value>` • `string`

<ResponseField name="--apiKey" type="string">
Your Runpod API key, which authenticates the CLI to access your account. You can generate an API key from the [Runpod console](https://www.runpod.io/console/user/settings).
</ResponseField>

---

`--apiUrl <value>` • `string` • default = `https://api.runpod.io/graphql`

<ResponseField name="--apiUrl" type="string" default="https://api.runpod.io/graphql">
The Runpod API endpoint URL. The default value should work for most users.
</ResponseField>
113 changes: 42 additions & 71 deletions runpodctl/reference/runpodctl-create-pod.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,114 +14,85 @@ runpodctl create pod [flags]
Create a Pod with 2 RTX 4090 GPUs in the Secure Cloud with a custom container image:

```sh
runpodctl create pod --name "my-training-pod" --gpuType "RTX 4090" --gpuCount 2 --secureCloud --imageName "runpod/pytorch:2.0.1-py3.10-cuda11.8.0-devel" --containerDiskSize 50 --volumeSize 100
runpodctl create pod \
--name "my-training-pod" \
--gpuType "RTX 4090" \
--gpuCount 2 \
--secureCloud \
--imageName "runpod/pytorch:2.0.1-py3.10-cuda11.8.0-devel" \
--containerDiskSize 50 \
--volumeSize 100
```

## Flags

The following flags are available for the `create pod` command:

---

`--name <value>` • `string`

<ResponseField name="--name" type="string">
A custom name for your Pod to make it easy to identify and reference.
</ResponseField>

---

`--gpuType <value>` • `string`

<ResponseField name="--gpuType" type="string">
The [GPU type](/references/gpu-types) to use for the Pod (e.g., `RTX 4090`, `A100 80GB`, `H100 SXM`).
</ResponseField>

---

`--gpuCount <number>` • `integer` • default = `1`

<ResponseField name="--gpuCount" type="integer" default={1}>
The number of GPUs to allocate to the Pod.
</ResponseField>

---

`--secureCloud`

<ResponseField name="--secureCloud">
Create the Pod in the Secure Cloud tier, which offers enterprise-grade infrastructure with enhanced reliability.
</ResponseField>

---

`--communityCloud`

<ResponseField name="--communityCloud">
Create the Pod in the Community Cloud tier, which typically offers lower pricing with spot instance availability.
</ResponseField>

---

`--imageName <value>` • `string`

<ResponseField name="--imageName" type="string">
The Docker container image to use for the Pod (e.g., `runpod/pytorch:latest`).
</ResponseField>

---

`--templateId <value>` • `string`

<ResponseField name="--templateId" type="string">
The ID of a template to use for Pod configuration, which pre-defines the image and environment settings.
</ResponseField>

---

`--containerDiskSize <number>` • `integer` • default = `20`

<ResponseField name="--containerDiskSize" type="integer" default={20}>
The size of the container disk in gigabytes, used for temporary storage within the container.
</ResponseField>

---

`--volumeSize <number>` • `integer` • default = `1`

<ResponseField name="--volumeSize" type="integer" default={1}>
The size of the persistent volume in gigabytes, which retains data across Pod restarts.
</ResponseField>

---

`--volumePath <value>` • `string` • default = `/workspace`

<ResponseField name="--volumePath" type="string" default="/workspace">
The mount path for the persistent volume inside the container.
</ResponseField>

---

`--networkVolumeId <value>` • `string`

<ResponseField name="--networkVolumeId" type="string">
The ID of an existing [network volume](/storage/network-volumes) to attach to the Pod for shared storage across multiple Pods.
</ResponseField>

---

`--cost <number>` • `float`

<ResponseField name="--cost" type="float">
The maximum price ceiling in dollars per hour. If not specified, the Pod will be created at the lowest available price.
</ResponseField>

---

`--mem <number>` • `integer` • default = `20`

<ResponseField name="--mem" type="integer" default={20}>
The minimum system memory required in gigabytes.
</ResponseField>

---

`--vcpu <number>` • `integer` • default = `1`

<ResponseField name="--vcpu" type="integer" default={1}>
The minimum number of vCPUs required for the Pod.
</ResponseField>

---

`--env <value>` • `string`

<ResponseField name="--env" type="string">
Environment variables to set in the container. Specify multiple times for multiple variables (e.g., `--env KEY1=VALUE1 -env KEY2=VALUE2`).
</ResponseField>

---

`--args <value>` • `string`

<ResponseField name="--args" type="string">
Additional arguments to pass to the container when it starts.
</ResponseField>

---

`--ports <value>` • `string`

<ResponseField name="--ports" type="string">
Ports to expose from the container. Maximum of 1 HTTP port and 1 TCP port allowed (e.g., `--ports 8888/http --ports 22/tcp`).
</ResponseField>

## Related commands

Expand Down
120 changes: 44 additions & 76 deletions runpodctl/reference/runpodctl-create-pods.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,123 +11,91 @@ runpodctl create pods [flags]

## Example

Create 3 identical Pods for distributed training in the Secure Cloud:
Create 3 identical Pods with the name "training-worker" in the Secure Cloud:

```sh
runpodctl create pods --name "training-worker" --podCount 3 --gpuType "A100 80GB" --gpuCount 1 --secureCloud --imageName "runpod/pytorch:2.0.1-py3.10-cuda11.8.0-devel"
runpodctl create pods
--name "training-worker" \
--podCount 3 \
--gpuType "A100 80GB" \
--gpuCount 1 \
--secureCloud \
--imageName "runpod/pytorch:2.0.1-py3.10-cuda11.8.0-devel"
```

## Flags

The following flags are available for the `create pods` command:

---

`--name <value>` • `string`

<ResponseField name="--name" type="string">
A custom name for the Pods. All Pods in the group will share this base name.
</ResponseField>

---

`--podCount <number>` • `integer` • default = `1`

<ResponseField name="--podCount" type="integer" default={1}>
The number of Pods to create.
</ResponseField>

---

`--gpuType <value>` • `string`

<ResponseField name="--gpuType" type="string">
The GPU type to use for the Pods (e.g., `RTX 4090`, `A100 80GB`, `H100 SXM`).
</ResponseField>

---

`--gpuCount <number>` • `integer` • default = `1`

<ResponseField name="--gpuCount" type="integer" default={1}>
The number of GPUs to allocate to each Pod.
</ResponseField>

---

`--secureCloud`

<ResponseField name="--secureCloud">
Create the Pods in the Secure Cloud tier, which offers enterprise-grade infrastructure with enhanced reliability.
</ResponseField>

---

`--communityCloud`

<ResponseField name="--communityCloud">
Create the Pods in the Community Cloud tier, which typically offers lower pricing with spot instance availability.
</ResponseField>

---

`--imageName <value>` • `string`

<ResponseField name="--imageName" type="string">
The Docker container image to use for the Pods (e.g., `runpod/pytorch:latest`).
</ResponseField>

---

`--templateId <value>` • `string`

<ResponseField name="--templateId" type="string">
The ID of a template to use for Pod configuration, which pre-defines the image and environment settings.
</ResponseField>

---

`--containerDiskSize <number>` • `integer` • default = `20`

<ResponseField name="--containerDiskSize" type="integer" default={20}>
The size of the container disk in gigabytes for each Pod.
</ResponseField>

---

`--volumeSize <number>` • `integer` • default = `1`

<ResponseField name="--volumeSize" type="integer" default={1}>
The size of the persistent volume in gigabytes for each Pod.
</ResponseField>

---

`--volumePath <value>` • `string` • default = `/workspace`

<ResponseField name="--volumePath" type="string" default="/workspace">
The mount path for the persistent volume inside each container.
</ResponseField>

---

`--networkVolumeId <value>` • `string`

<ResponseField name="--networkVolumeId" type="string">
The ID of an existing network volume to attach to all Pods for shared storage.
</ResponseField>

---

`--cost <number>` • `float`

<ResponseField name="--cost" type="float">
The maximum price ceiling in dollars per hour. If not specified, Pods will be created at the lowest available price.
</ResponseField>

---

`--mem <number>` • `integer` • default = `20`

<ResponseField name="--mem" type="integer" default={20}>
The minimum system memory required in gigabytes for each Pod.
</ResponseField>

---

`--vcpu <number>` • `integer` • default = `1`

<ResponseField name="--vcpu" type="integer" default={1}>
The minimum number of vCPUs required for each Pod.
</ResponseField>

---

`--env <value>` • `string`

<ResponseField name="--env" type="string">
Environment variables to set in the containers. Specify multiple times for multiple variables.
</ResponseField>

---

`--args <value>` • `string`

<ResponseField name="--args" type="string">
Additional arguments to pass to the containers when they start.
</ResponseField>

---

`--ports <value>` • `string`

<ResponseField name="--ports" type="string">
Ports to expose from the containers. Maximum of 1 HTTP port and 1 TCP port allowed per Pod.
</ResponseField>

## Related commands

Expand Down
Loading