Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl config [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-create-pod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl create pod [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-create-pods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ sidebarTitle: "create pods"

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

```sh
<RequestExample>
```sh Command
runpodctl create pods [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-get-cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl get cloud <gpuCount> [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-get-pod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ sidebarTitle: "get pod"

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

```sh
<RequestExample>
```sh Command
runpodctl get pod <podId> [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-receive.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl receive <code> [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-remove-pod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ sidebarTitle: "remove pod"

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

```sh
<RequestExample>
```sh Command
runpodctl remove pod <podId>
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-remove-pods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl remove pods <name> [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-send.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl send <fileOrFolder> [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-ssh-add-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl ssh add-key [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-ssh-list-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ sidebarTitle: "ssh list-keys"

Display all SSH keys associated with your Runpod account.

```sh
<RequestExample>
```sh Command
runpodctl ssh list-keys [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-start-pod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl start pod <podId> [flags]
```
</RequestExample>

## Example

Expand Down
4 changes: 3 additions & 1 deletion runpodctl/reference/runpodctl-stop-pod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<RequestExample>
```sh Command
runpodctl stop pod <podId> [flags]
```
</RequestExample>

## Example

Expand Down
5 changes: 3 additions & 2 deletions runpodctl/reference/runpodctl-update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ sidebarTitle: "update"

Update `runpodctl` to the latest version to access new features and bug fixes.

```sh
<RequestExample>
```sh Command
runpodctl update
```

</RequestExample>

## Related commands

Expand Down
6 changes: 3 additions & 3 deletions runpodctl/reference/runpodctl-version.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebarTitle: "version"

Display the current version of `runpodctl` installed on your system.

```sh
<RequestExample>
```sh Command
runpodctl version
```


</RequestExample>

## Related commands

Expand Down