Skip to content

docs: Update runpodctl documentation for v2.0#563

Open
promptless[bot] wants to merge 7 commits intomainfrom
promptless/runpodctl-v2-documentation
Open

docs: Update runpodctl documentation for v2.0#563
promptless[bot] wants to merge 7 commits intomainfrom
promptless/runpodctl-v2-documentation

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 20, 2026

Open this suggestion in Promptless to view citations and reasoning process

Comprehensive update of the Runpod CLI documentation for version 2.0. Adds new reference pages for all command groups (pod, serverless, template, network-volume, model, registry, gpu, datacenter, billing, user, ssh, doctor), updates the overview with a quick start guide, and adds redirects for backward compatibility with old v1.x URLs.

Trigger Events

Internal discussion about updating runpodctl documentation based on recent changes to the skill file and source code.

Promptless Research (9 files, 2 webpages)

  • Read webpage from github.com
  • Read webpage from github.com
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed .long_term_context/style/client_style_guide.md
  • Viewed runpodctl/overview.mdx
  • Viewed runpodctl/manage-pods.mdx
  • Viewed runpodctl/transfer-files.mdx
  • Viewed runpodctl/reference/runpodctl-create-pod.mdx
  • Viewed runpodctl/reference/runpodctl-get-pod.mdx
  • Viewed docs.json

Agent Response

I've created a comprehensive documentation update for runpodctl v2.0. Here's a summary of the changes:

Documentation suggestion created

Title: Update runpodctl documentation for v2.0

Changes made:

Updated runpodctl/overview.mdx:

  • Added quick start section showing v2.0 commands
  • Updated installation URLs to use /latest/download/ instead of hardcoded versions
  • Added runpodctl doctor for first-time setup
  • Added command groups table showing all available commands and aliases
  • Added shell completion instructions

Created 12 new reference pages:

  • runpodctl-doctor.mdx - First-time setup and diagnostics
  • runpodctl-pod.mdx - Comprehensive Pod management (create, list, start, stop, delete, etc.)
  • runpodctl-serverless.mdx - Serverless endpoint management
  • runpodctl-template.mdx - Template listing, search, and management
  • runpodctl-network-volume.mdx - Network volume management
  • runpodctl-model.mdx - Model management
  • runpodctl-registry.mdx - Container registry authentication
  • runpodctl-gpu.mdx - List available GPUs
  • runpodctl-datacenter.mdx - List datacenters
  • runpodctl-billing.mdx - View billing history
  • runpodctl-user.mdx - Account information
  • runpodctl-ssh.mdx - SSH key and connection management

Removed old v1.x reference pages (with redirects for backward compatibility):

  • Old pages like runpodctl-create-pod, runpodctl-get-pod, etc. now redirect to the new consolidated runpodctl-pod page

Updated docs.json:

  • Updated navigation to include new pages
  • Added 10 redirects for old URLs to maintain backward compatibility

The key change in v2.0 is the command structure: commands now use a noun-verb pattern (e.g., runpodctl pod create instead of runpodctl create pod), and there are many new command groups for managing Serverless endpoints, templates, network volumes, and more.


Tip: Attach PDFs in Slack messages to Promptless—it can even extract images from them 📎

@mintlify
Copy link

mintlify bot commented Mar 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Mar 20, 2026, 10:46 PM

@@ -0,0 +1,92 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: Serverless commands documented from the Serverless (alias: sls) section in the runpodctl v2.0 SKILL.md.
View source

@@ -0,0 +1,37 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: New doctor command for first-time setup documented from the Utilities section in SKILL.md.
View source

@@ -0,0 +1,58 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: GPU listing commands documented from the Info section in SKILL.md.
View source

@promptless
Copy link
Contributor Author

promptless bot commented Mar 23, 2026

I've added new changes to address this GitHub PR in commit 79e8158

```bash
runpodctl pod create --template-id runpod-torch-v21 --gpu-id "NVIDIA RTX 4090"
```

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: New filtering flags (--all, --status, --since, --created-after) and default behavior change (showing only running pods) based on changes in cmd/pod/list.go. Also removed deprecated --include-machine and --include-network-volume flags from internal/api/pods.go.
View source

@promptless
Copy link
Contributor Author

promptless bot commented Mar 23, 2026

I've added new changes to address this GitHub PR in commit cd5a6d5


</Tab>

<Tab title="Windows">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: PR #235 adds aarch64/arm64 support for Linux in the install.sh script. The URL pattern runpodctl-linux-arm64 follows the new goreleaser naming convention from this PR.
View source

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant