Skip to content

docs(runpodctl): add a reference page for the model command - #973

Open
lukepiette wants to merge 1 commit into
mainfrom
docs/runpodctl-model-reference
Open

lukepiette wants to merge 1 commit into
mainfrom
docs/runpodctl-model-reference

Conversation

@lukepiette

Copy link
Copy Markdown
Contributor

What

runpodctl model manages the Runpod model repository, and it had no page in the CLI reference. This adds runpodctl/reference/runpodctl-model.mdx covering model list, model add, and model remove, and adds it to the CLI navigation.

How it was written and tested

  • Written from the --help output of a runpodctl v3.1.1 build (the latest release). A script confirms every flag on the page exists on the matching subcommand, and that no flag is missing.
  • I ran the binary, without credentials, to confirm the rules the page states:
    • model add requires --name.
    • --huggingface-model can't be combined with --model-path.
    • --delete-my-model-files-after-upload is refused without --wait-for-hash.
    • model remove requires both --name and --owner.
    • ls, and rm/delete, work as aliases.

Please check before merging

  • Is the model repository ready to be documented publicly? This would be the first mention of it on docs.runpod.io. The command ships in the public CLI, and the public agent skills already describe it, but the docs have no concept page for it. If it isn't ready, hold this PR.
  • No upload or removal was run against an account, since no API key was available here. Output shapes and the "blocked while an endpoint references it" behavior come from the CLI's help text.
  • Several model add flags (--create-upload, --file-name, --file-size, --content-type, --part-size, --model-status, --credential-type, --credential-reference) have one-line help only, so their descriptions here are equally brief. Someone who knows the upload-session flow should expand them.
  • The page doesn't explain how to attach a repository model to an endpoint, because I couldn't confirm the reference format.

Related

🤖 Generated with Claude Code

runpodctl model (add, list, remove) had no reference page. Written from the
help text of a runpodctl v3.1.1 build, with every flag checked against it.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Nov 14, 2026, 8:15 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — b81bae3a Deployed Nov 14, 2026 by mintlify[bot]
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.

2 participants