diff --git a/runpodctl/reference/runpodctl-config.mdx b/runpodctl/reference/runpodctl-config.mdx index 584a73fc..9d464c98 100644 --- a/runpodctl/reference/runpodctl-config.mdx +++ b/runpodctl/reference/runpodctl-config.mdx @@ -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 ` • `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). + ---- - -`--apiUrl ` • `string` • default = `https://api.runpod.io/graphql` - + The Runpod API endpoint URL. The default value should work for most users. + diff --git a/runpodctl/reference/runpodctl-create-pod.mdx b/runpodctl/reference/runpodctl-create-pod.mdx index 2e26db6e..9e4f2278 100644 --- a/runpodctl/reference/runpodctl-create-pod.mdx +++ b/runpodctl/reference/runpodctl-create-pod.mdx @@ -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 ` • `string` - + A custom name for your Pod to make it easy to identify and reference. + ---- - -`--gpuType ` • `string` - + The [GPU type](/references/gpu-types) to use for the Pod (e.g., `RTX 4090`, `A100 80GB`, `H100 SXM`). + ---- - -`--gpuCount ` • `integer` • default = `1` - + The number of GPUs to allocate to the Pod. + ---- - -`--secureCloud` - + Create the Pod in the Secure Cloud tier, which offers enterprise-grade infrastructure with enhanced reliability. + ---- - -`--communityCloud` - + Create the Pod in the Community Cloud tier, which typically offers lower pricing with spot instance availability. + ---- - -`--imageName ` • `string` - + The Docker container image to use for the Pod (e.g., `runpod/pytorch:latest`). + ---- - -`--templateId ` • `string` - + The ID of a template to use for Pod configuration, which pre-defines the image and environment settings. + ---- - -`--containerDiskSize ` • `integer` • default = `20` - + The size of the container disk in gigabytes, used for temporary storage within the container. + ---- - -`--volumeSize ` • `integer` • default = `1` - + The size of the persistent volume in gigabytes, which retains data across Pod restarts. + ---- - -`--volumePath ` • `string` • default = `/workspace` - + The mount path for the persistent volume inside the container. + ---- - -`--networkVolumeId ` • `string` - + The ID of an existing [network volume](/storage/network-volumes) to attach to the Pod for shared storage across multiple Pods. + ---- - -`--cost ` • `float` - + The maximum price ceiling in dollars per hour. If not specified, the Pod will be created at the lowest available price. + ---- - -`--mem ` • `integer` • default = `20` - + The minimum system memory required in gigabytes. + ---- - -`--vcpu ` • `integer` • default = `1` - + The minimum number of vCPUs required for the Pod. + ---- - -`--env ` • `string` - + Environment variables to set in the container. Specify multiple times for multiple variables (e.g., `--env KEY1=VALUE1 -env KEY2=VALUE2`). + ---- - -`--args ` • `string` - + Additional arguments to pass to the container when it starts. + ---- - -`--ports ` • `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`). + ## Related commands diff --git a/runpodctl/reference/runpodctl-create-pods.mdx b/runpodctl/reference/runpodctl-create-pods.mdx index 7b560bf3..8c0a6f31 100644 --- a/runpodctl/reference/runpodctl-create-pods.mdx +++ b/runpodctl/reference/runpodctl-create-pods.mdx @@ -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 ` • `string` - + A custom name for the Pods. All Pods in the group will share this base name. + ---- - -`--podCount ` • `integer` • default = `1` - + The number of Pods to create. + ---- - -`--gpuType ` • `string` - + The GPU type to use for the Pods (e.g., `RTX 4090`, `A100 80GB`, `H100 SXM`). + ---- - -`--gpuCount ` • `integer` • default = `1` - + The number of GPUs to allocate to each Pod. + ---- - -`--secureCloud` - + Create the Pods in the Secure Cloud tier, which offers enterprise-grade infrastructure with enhanced reliability. + ---- - -`--communityCloud` - + Create the Pods in the Community Cloud tier, which typically offers lower pricing with spot instance availability. + ---- - -`--imageName ` • `string` - + The Docker container image to use for the Pods (e.g., `runpod/pytorch:latest`). + ---- - -`--templateId ` • `string` - + The ID of a template to use for Pod configuration, which pre-defines the image and environment settings. + ---- - -`--containerDiskSize ` • `integer` • default = `20` - + The size of the container disk in gigabytes for each Pod. + ---- - -`--volumeSize ` • `integer` • default = `1` - + The size of the persistent volume in gigabytes for each Pod. + ---- - -`--volumePath ` • `string` • default = `/workspace` - + The mount path for the persistent volume inside each container. + ---- - -`--networkVolumeId ` • `string` - + The ID of an existing network volume to attach to all Pods for shared storage. + ---- - -`--cost ` • `float` - + The maximum price ceiling in dollars per hour. If not specified, Pods will be created at the lowest available price. + ---- - -`--mem ` • `integer` • default = `20` - + The minimum system memory required in gigabytes for each Pod. + ---- - -`--vcpu ` • `integer` • default = `1` - + The minimum number of vCPUs required for each Pod. + ---- - -`--env ` • `string` - + Environment variables to set in the containers. Specify multiple times for multiple variables. + ---- - -`--args ` • `string` - + Additional arguments to pass to the containers when they start. + ---- - -`--ports ` • `string` - + Ports to expose from the containers. Maximum of 1 HTTP port and 1 TCP port allowed per Pod. + ## Related commands diff --git a/runpodctl/reference/runpodctl-get-cloud.mdx b/runpodctl/reference/runpodctl-get-cloud.mdx index eb5c8c87..51b60f15 100644 --- a/runpodctl/reference/runpodctl-get-cloud.mdx +++ b/runpodctl/reference/runpodctl-get-cloud.mdx @@ -19,40 +19,28 @@ runpodctl get cloud 4 --secure ## Arguments -`` • `integer` • optional, default = `1` - + The minimum number of GPUs that must be available for each option listed. + ## Flags -The following flags are available for the `get cloud` command: - ---- - -`--disk ` • `integer` - + Filter for GPUs with a minimum disk size (in gigabytes). + ---- - -`--mem ` • `integer` - + Filter for GPUs with a minimum system memory size (in gigabytes). + ---- - -`--vcpu ` • `integer` - + Filter for GPUs with a minimum number of vCPUs. + ---- - -`-s, --secure` - + List only GPUs from the [Secure Cloud](https://docs.runpod.io/pods/choose-a-pod#secure-cloud-vs-community-cloud). + ---- - -`-c, --community` - + List only GPUs from the [Community Cloud](https://docs.runpod.io/pods/choose-a-pod#secure-cloud-vs-community-cloud). + diff --git a/runpodctl/reference/runpodctl-get-pod.mdx b/runpodctl/reference/runpodctl-get-pod.mdx index 5f466c27..ce44fe32 100644 --- a/runpodctl/reference/runpodctl-get-pod.mdx +++ b/runpodctl/reference/runpodctl-get-pod.mdx @@ -19,16 +19,12 @@ runpodctl get pod --allfields ## Arguments -`` • `string` • optional - + The ID of a specific Pod to retrieve. If no ID is provided, all Pods will be listed. + ## Flags -The following flags are available for the `get pod` command: - ---- - -`-a, --allfields` - + Include all available fields in the output, providing complete Pod information. + diff --git a/runpodctl/reference/runpodctl-receive.mdx b/runpodctl/reference/runpodctl-receive.mdx index abe1d563..9611f8af 100644 --- a/runpodctl/reference/runpodctl-receive.mdx +++ b/runpodctl/reference/runpodctl-receive.mdx @@ -19,9 +19,9 @@ runpodctl receive rainbow-unicorn-42 ## Arguments -`` • `string` • optional - + The connection code phrase that matches the code used by the sender with the `send` command. If not provided, you'll be prompted to enter it. + ## Related commands diff --git a/runpodctl/reference/runpodctl-remove-pod.mdx b/runpodctl/reference/runpodctl-remove-pod.mdx index 5bdf3e9c..5b004564 100644 --- a/runpodctl/reference/runpodctl-remove-pod.mdx +++ b/runpodctl/reference/runpodctl-remove-pod.mdx @@ -19,9 +19,9 @@ runpodctl remove pod abc123xyz456 ## Arguments -`` • `string` • required - + The ID of the Pod to terminate. You can find Pod IDs using the `runpodctl get pod` command. + ## Related commands diff --git a/runpodctl/reference/runpodctl-remove-pods.mdx b/runpodctl/reference/runpodctl-remove-pods.mdx index 2fdffe13..0bea4a53 100644 --- a/runpodctl/reference/runpodctl-remove-pods.mdx +++ b/runpodctl/reference/runpodctl-remove-pods.mdx @@ -19,19 +19,15 @@ runpodctl remove pods training-worker ## Arguments -`` • `string` • required - + The name of the Pods to terminate. All Pods with this exact name will be removed. + ## Flags -The following flags are available for the `remove pods` command: - ---- - -`--podCount ` • `integer` • optional - + The number of Pods with the specified name to terminate. This limits the removal to a specific count rather than removing all matching Pods. + ## Related commands diff --git a/runpodctl/reference/runpodctl-send.mdx b/runpodctl/reference/runpodctl-send.mdx index 0e43542f..a4f5ce74 100644 --- a/runpodctl/reference/runpodctl-send.mdx +++ b/runpodctl/reference/runpodctl-send.mdx @@ -19,19 +19,15 @@ runpodctl send ./my-dataset --code rainbow-unicorn-42 ## Arguments -`` • `string` • required - + The path to the file or folder you want to send. Can be a single file or an entire directory. + ## Flags -The following flags are available for the `send` command: - ---- - -`--code ` • `string` - + A custom code phrase used to establish the secure connection between sender and receiver. The receiver must use the same code with the `receive` command. + ## Related commands diff --git a/runpodctl/reference/runpodctl-ssh-add-key.mdx b/runpodctl/reference/runpodctl-ssh-add-key.mdx index bb05b6c0..1f4c1f72 100644 --- a/runpodctl/reference/runpodctl-ssh-add-key.mdx +++ b/runpodctl/reference/runpodctl-ssh-add-key.mdx @@ -19,19 +19,13 @@ runpodctl ssh add-key --key-file ~/.ssh/id_rsa.pub ## Flags -The following flags are available for the `ssh add-key` command: - ---- - -`--key ` • `string` - + The SSH public key content to add to your account. This should be the full public key string. + ---- - -`--key-file ` • `string` - + The path to a file containing the SSH public key to add. This is typically a `.pub` file from your SSH key pair. + ## Related commands diff --git a/runpodctl/reference/runpodctl-start-pod.mdx b/runpodctl/reference/runpodctl-start-pod.mdx index 5560ad0d..d3dc4b31 100644 --- a/runpodctl/reference/runpodctl-start-pod.mdx +++ b/runpodctl/reference/runpodctl-start-pod.mdx @@ -19,19 +19,15 @@ runpodctl start pod abc123xyz456 --bid 0.50 ## Arguments -`` • `string` • required - + The ID of the Pod to start. You can find Pod IDs using the `runpodctl get pod` command. + ## Flags -The following flags are available for the `start pod` command: - ---- - -`--bid ` • `float` - + The bid price per GPU in dollars per hour for spot instance pricing. This only applies to Community Cloud Pods. + ## Related commands diff --git a/runpodctl/reference/runpodctl-stop-pod.mdx b/runpodctl/reference/runpodctl-stop-pod.mdx index 1ce5465e..1d98418c 100644 --- a/runpodctl/reference/runpodctl-stop-pod.mdx +++ b/runpodctl/reference/runpodctl-stop-pod.mdx @@ -19,9 +19,9 @@ runpodctl stop pod abc123xyz456 ## Arguments -`` • `string` • required - + The ID of the Pod to stop. You can find Pod IDs using the `runpodctl get pod` command. + ## Related commands