docs: Update runpodctl documentation for v2.0#563
docs: Update runpodctl documentation for v2.0#563promptless[bot] wants to merge 18 commits intomainfrom
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
TimPietruskyRunPod
left a comment
TimPietruskyRunPod
left a comment
There was a problem hiding this comment.
Overall this is a solid restructuring of the docs for v2.0 — the redirects, updated install URLs, and new reference pages look great. A few things need fixing before merge:
- Outdated docker image in pod create example
- Missing
--network-volume-idflag on serverless create - Shell completion instructions are wrong
- Serverless list flags undocumented
See inline comments for details.
|
I've added new changes to address this Slack message in commit 08fb45d |
| Create a Pod with a custom Docker image: | ||
|
|
||
| ```bash | ||
| runpodctl pod create --image "runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04" --gpu-id "NVIDIA GeForce RTX 4090" |
There was a problem hiding this comment.
Citation: Updated Docker image from outdated runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04 to the newer runpod/pytorch:1.0.3-cu1281-torch291-ubuntu2404 based on review feedback from Tim Pietrusky. Also fixed in the CLI help text itself in PR #260.
View source
There was a problem hiding this comment.
(Line 210)
Citation: Fixed shell completion documentation based on review feedback from Tim Pietrusky. runpodctl completion takes no arguments—it auto-detects the shell via $SHELL env var and appends the appropriate source command. This was also corrected in the SKILL file in PR #11.
View source
| runpodctl serverless list | ||
| ``` | ||
|
|
||
| ### Get endpoint details |
There was a problem hiding this comment.
Citation: Added --include-template and --include-workers flags for the serverless list command based on review feedback from Tim Pietrusky. These flags exist in cmd/serverless/list.go (not just get).
View source
muhsinking
dismissed
TimPietruskyRunPod’s stale review
Requested changes were completed by Promptless
| <ResponseField name="--gpu-count" type="int" default="1"> | ||
| Number of GPUs per worker. | ||
| </ResponseField> | ||
|
|
There was a problem hiding this comment.
Citation: New --hub-id flag added to serverless create in PR #262. When --hub-id is used, the CLI resolves the listing, extracts the build image and config from the latest release, and deploys the endpoint. Changes in cmd/serverless/create.go.
View source
Resolved conflict: runpodctl/reference/runpodctl-create-pod.mdx - Kept deletion since v2 consolidates pod commands into runpodctl-pod.mdx Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Update CLI tests to use v2 noun-verb syntax (pod list, pod create, etc.) - Add 10 new tests covering v2 commands (serverless, hub, templates, etc.) - Update pods/manage-pods.mdx CLI examples to v2 syntax - Update pods/connect-to-a-pod.mdx Pod creation example to v2 syntax - Update test counts in .claude/commands/test.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add note to serverless docs explaining template type requirements - Add note to template docs about pod vs serverless template differences - Update --serverless flag description with volume disk and binding constraints - Use VolumeDiskTooltip for clarity (serverless doesn't support volume disks, but does support network volumes) Discovered during CLI test batch: serverless endpoints require serverless-specific templates (not pod templates), and each serverless template can only be bound to one endpoint. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replace REST API examples with runpodctl commands in Terminal tabs: - Step 2: Use `runpodctl pod create` instead of curl POST - Step 3: Use `runpodctl ssh info` instead of curl GET - Step 4: Use `runpodctl pod stop/delete` instead of curl Also mention `runpodctl doctor` for SSH key setup. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2 participants
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)
.long_term_context/product_knowledge/product_overview.md.long_term_context/doc_workflow/client_instructions.md.long_term_context/style/client_style_guide.mdrunpodctl/overview.mdxrunpodctl/manage-pods.mdxrunpodctl/transfer-files.mdxrunpodctl/reference/runpodctl-create-pod.mdxrunpodctl/reference/runpodctl-get-pod.mdxdocs.jsonAgent Response
Tip: Attach PDFs in Slack messages to Promptless—it can even extract images from them 📎