docs: Document runpodctl model commands with add, list, and remove - #644
docs: Document runpodctl model commands with add, list, and remove#644promptless[bot] wants to merge 6 commits into
Conversation
Document the runpodctl model list command, including the new Version Hash column that displays the model version hash needed for the --model-reference flag when creating Serverless endpoints.
- Add model add subcommand with all flags including new --owner flag - Add model remove subcommand documentation - Document --provider and --name filter flags for model list - Add RUNPOD_GRAPHQL_URL environment variable documentation - Remove --all flag from list (removed in runpodctl PR #283) - Remove --version-status flag from add (removed in runpodctl PR #283)
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| sidebarTitle: "model" | ||
| --- | ||
|
|
||
| Manage models in the Model Repo, including adding, uploading, listing, and removing models. |
There was a problem hiding this comment.
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
| runpodctl model add --name "my-model" --model-path ./model-files | ||
| ``` | ||
|
|
||
| #### Add flags |
There was a problem hiding this comment.
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
|
|
||
| ```bash | ||
| runpodctl model remove my-model | ||
| ``` |
There was a problem hiding this comment.
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
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Recommend closing this PR in favor of #710. Rationale:
#710 is the more current and accurate reference (traces directly to the actual source PRs, including the just-reviewed HF-mirroring flag). Recommend closing this one to avoid the merge collision rather than trying to reconcile the two. |
|
@Promptless can you check if the triggered PRs are merged? Check if all the doc changes are covered. |
|
Update: both source PRs (#278 and #283) are merged. One important detail surfaced — the later PR (#283) changed the |
|
Thanks for checking in. Both upstream This PR accurately covers the current command surface: it documents One change isn't yet reflected: #283 also switched |
|
@Promptless add the note |
|
Thanks — on it. We'll extend this PR to add a brief note documenting that |
|
Quick update: we've confirmed the current behavior against the runpodctl source. As of PR #283, |
|
|
||
| ## 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`: |
There was a problem hiding this comment.
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
| 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`: | ||
|
|
||
| ```bash | ||
| runpodctl model list -o yaml |
There was a problem hiding this comment.
-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
| --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. |
There was a problem hiding this comment.
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
|
Done — the note is added to this PR. There's now a brief "Output format" section on the runpodctl model command reference documenting that |
2 participants
Open this suggestion in Promptless to view citations and reasoning process
Expands the runpodctl model command reference to include all subcommands: model add (with --owner flag for team accounts), model list (with --provider and --name filters), and model remove. Also documents the RUNPOD_GRAPHQL_URL environment variable for custom GraphQL endpoints.
Adds a brief Output format note documenting that the
model add,model list, andmodel removesubcommands now return structured output — JSON by default, or YAML via runpodctl's global-o/--outputflag — and clarifies that a model's version hash now surfaces as a field in that output rather than as a table column.Trigger Events
Requested follow-up (this PR)
Applied @lavanya-gunreddi's approved request ("add the note") to document the structured JSON/YAML output. Behavior and flag names were verified against current runpodctl source:
-o/--outputis the CLI's pre-existing global output flag (defaultjson, acceptsjson/yaml), so the note frames it as global rather than model-command-specific.Tip: Use Slack message actions (⋯ menu → Update Docs) to capture doc updates without interrupting conversations 💬