Skip to content
Open
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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,7 @@
"runpodctl/reference/runpodctl-serverless",
"runpodctl/reference/runpodctl-template",
"runpodctl/reference/runpodctl-hub",
"runpodctl/reference/runpodctl-model",
"runpodctl/reference/runpodctl-network-volume",
"runpodctl/reference/runpodctl-registry",
"runpodctl/reference/runpodctl-gpu",
Expand Down
1 change: 1 addition & 0 deletions runpodctl/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Gunning-Fog index (11.94) below 10.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Coleman–Liau Index grade (13.37) below 9.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the SMOG grade (12.40) below 10.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Flesch reading ease score (45.51) above 70.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Flesch–Kincaid grade level (10.66) below 8.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Automated Readability Index (11.06) below 8.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the LIX score (45.21) below 35.
title: "Overview"
sidebarTitle: "Overview"
description: "Use Runpod CLI to manage Pods, Serverless endpoints, templates, and more from your local machine. Review commands and usage guidance for the Runpod CLI."

Check warning on line 4 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L4

Use 'command-line tool' instead of 'CLI'.

Check warning on line 4 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L4

Use 'command-line tool' instead of 'CLI'.
---

import { PodsTooltip, PodTooltip } from "/snippets/tooltips.jsx";

Runpod CLI is an [open source](https://github.com/runpod/runpodctl) command-line tool for managing your Runpod resources from your local machine. You can manage Pods, Serverless endpoints, templates, network volumes, and models, transfer files between your system and Runpod, diagnose issues, and view account information.

Check warning on line 9 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L9

Use 'command-line tool' instead of 'CLI'.

## Quick start

Expand All @@ -20,7 +20,7 @@
runpodctl pod list # List your Pods
```

## Install Runpod CLI locally

Check warning on line 23 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L23

'Install Runpod CLI locally' should use sentence-style capitalization.

Check warning on line 23 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L23

Use 'command-line tool' instead of 'CLI'.

Every <PodTooltip /> you deploy comes preinstalled with `runpodctl` and a Pod-scoped API key. You can also install it on your local machine to manage resources remotely.

Expand Down Expand Up @@ -149,7 +149,7 @@
runpodctl doctor
```

This command guides you through first-time setup, including API key configuration and SSH key setup.

Check warning on line 152 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L152

Use the Oxford comma in ', including API key configuration and SSH key setup.'.

Alternatively, you can manually configure your API key:

Expand All @@ -162,7 +162,7 @@
saved apiKey into config file: /Users/runpod/.runpod/config.toml
```

### Step 3: Verify installation

Check warning on line 165 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L165

'Step 3: Verify installation' should use sentence-style capitalization.

To verify that `runpodctl` installed successfully, run this command:

Expand All @@ -170,7 +170,7 @@
runpodctl version
```

You should see which version is installed:

Check warning on line 173 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L173

In general, use active voice instead of passive voice ('is installed').

```bash
runpodctl v2.0
Expand All @@ -178,14 +178,15 @@

## Command groups

Runpod CLI organizes commands into groups based on the resource type:

Check warning on line 181 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L181

Use 'command-line tool' instead of 'CLI'.

| Command | Alias | Description |
|---------|-------|-------------|
| `runpodctl pod` | | Manage Pods (create, list, start, stop, delete) |

Check warning on line 185 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L185

Use parentheses judiciously.
| `runpodctl serverless` | `sls` | Manage Serverless endpoints |
| `runpodctl template` | `tpl` | List, search, and manage templates |
| `runpodctl hub` | | Browse and deploy from the Runpod Hub |
| `runpodctl model` | | List available models |
| `runpodctl network-volume` | `nv` | Manage network volumes |
| `runpodctl registry` | `reg` | Manage container registry authentications |
| `runpodctl gpu` | | List available GPUs |
Expand All @@ -196,7 +197,7 @@

## Help and reference

Learn how to use Runpod CLI commands by browsing the CLI reference using the sidebar to the left, or by running the `help` command:

Check warning on line 200 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L200

Use 'command-line tool' instead of 'CLI'.

Check warning on line 200 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L200

Use 'command-line tool' instead of 'CLI'.

```bash
runpodctl help
Expand All @@ -215,6 +216,6 @@
runpodctl completion
```

This command auto-detects your shell and adds the appropriate source command to your shell configuration file (`~/.bashrc` or `~/.zshrc`). The command is idempotent—running it again skips installation if completion is already configured.

Check warning on line 219 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L219

Use parentheses judiciously.

Restart your shell or source the configuration file for changes to take effect.
151 changes: 151 additions & 0 deletions runpodctl/reference/runpodctl-model.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---

Check warning on line 1 in runpodctl/reference/runpodctl-model.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/reference/runpodctl-model.mdx#L1

Try to keep the Flesch reading ease score (65.26) above 70.
title: "model"
sidebarTitle: "model"
---

Manage models in the Model Repo, including adding, uploading, listing, and removing models.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added model command documentation based on PR #278, which introduces the Version Hash column to runpodctl model list. The version hash is needed for the --model-reference flag when creating Serverless endpoints.

Source: runpod/runpodctl#278


```bash
runpodctl model <subcommand> [flags]
```

## Subcommands

### Add a model

Register a new model with the Model Repo:

```bash
runpodctl model add --name "my-model"
```

To upload model files from a local directory:

```bash
runpodctl model add --name "my-model" --model-path ./model-files
```

#### Add flags

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added --owner flag documentation from PR #283 which introduced the flag in cmd/model/addModelToRepo.go:119. Also removed --version-status flag which was removed in the same PR.

Source: runpod/runpodctl#283


<ResponseField name="--name" type="string" required>
Model name.
</ResponseField>

<ResponseField name="--owner" type="string">
Model owner namespace (user or team owner ID). Use this to add models to a team account.
</ResponseField>

<ResponseField name="--model-status" type="string">
Initial model status.
</ResponseField>

<ResponseField name="--credential-type" type="string">
Credential type (if required for model access).
</ResponseField>

<ResponseField name="--credential-reference" type="string">
Credential reference (if required for model access).
</ResponseField>

<ResponseField name="--model-path" type="string">
Directory containing model files to upload. When specified, all files in the directory are uploaded to the Model Repo.
</ResponseField>

<ResponseField name="--create-upload" type="bool">
Create an upload session without uploading files. Use this to get upload URLs for manual file uploads.
</ResponseField>

<ResponseField name="--file-name" type="string">
File name for single-file upload.
</ResponseField>

<ResponseField name="--file-size" type="string">
File size in bytes for single-file upload.
</ResponseField>

<ResponseField name="--part-size" type="string">
Multipart upload part size in bytes.
</ResponseField>

<ResponseField name="--content-type" type="string">
Content type for the upload.
</ResponseField>

<ResponseField name="--graphql-timeout" type="duration">
GraphQL request timeout. Defaults to 30 minutes for model upload operations.
</ResponseField>

### List models

List models in your account:

```bash
runpodctl model list
```

Filter by provider or name:

```bash
runpodctl model list --provider huggingface
runpodctl model list --name "llama"
```

#### List flags

<ResponseField name="--provider" type="string">
Filter by model provider.
</ResponseField>

<ResponseField name="--name" type="string">
Filter by model name.
</ResponseField>

### Remove a model

Remove a model from the Model Repo:

```bash
runpodctl model remove <model-id>
```

You can specify the model by ID or name:

```bash
runpodctl model remove my-model
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added RUNPOD_GRAPHQL_URL environment variable documentation from PR #283 which changed the env var from RUNPOD_API_URL to RUNPOD_GRAPHQL_URL in api/query.go:35.

Source: runpod/runpodctl#283


<Warning>

Removing a model permanently deletes it and all associated versions from the Model Repo. This action cannot be undone.

</Warning>

## Environment variables

<ResponseField name="RUNPOD_GRAPHQL_URL" type="string">
Override the GraphQL API endpoint URL. Defaults to `https://api.runpod.io/graphql`.
</ResponseField>

## Output format

The `model add`, `model list`, and `model remove` subcommands return structured output, formatted as JSON by default. To get YAML instead, use runpodctl's global output flag, `-o` (or `--output`), which accepts `json` or `yaml`:

Check warning on line 131 in runpodctl/reference/runpodctl-model.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/reference/runpodctl-model.mdx#L131

Use parentheses judiciously.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

runpodctl PR #283 converted the model add/list/remove subcommands from human-readable text/tables to the shared structured-output (output.Print) path, so they now return JSON by default.

Source: runpod/runpodctl#283


```bash
runpodctl model list -o yaml

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-o/--output is a pre-existing persistent (global) root flag on rootCmd, defaulting to json and accepting json or yaml, so -o yaml works with any subcommand including model list.

Source: https://github.com/runpod/runpodctl/blob/fc93344965cb407f737eb9b8aa003f8a45749b79/cmd/root.go#L119

```

## Using model version hashes

To create a Serverless endpoint that uses a model from the Model Repo, reference the model by its version hash:

```bash
runpodctl serverless create --template-id "tpl_abc123" --name "my-endpoint" \
--model-reference "abc123def456"
```

Run `runpodctl model list` to find the version hash for your model. The hash appears as a field in the command's structured output.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR #283 removed the table renderer that previously showed a Version Hash column (added by PR #278); the hash now surfaces as a field in model list's structured JSON output (nested per model under versions[].hash).

Source: runpod/runpodctl#283


## Related commands

- [`runpodctl serverless create`](/runpodctl/reference/runpodctl-serverless)
- [`runpodctl hub`](/runpodctl/reference/runpodctl-hub)
Loading