docs: Document runpodctl template registry auth and port label flags - #774
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| Comma-separated list of ports to expose (e.g., `8888/http,22/tcp`). | ||
| </ResponseField> | ||
|
|
||
| <ResponseField name="--port-labels" type="string"> |
There was a problem hiding this comment.
Documented the new --port-labels create flag from cmd/template/create.go and cmd/template/port_labels.go, which accept either port=name pairs or a JSON object and require --ports (the code returns "--port-labels requires --ports when creating a template" and validates each label against --ports).
Source: runpod/runpodctl#290
| </ResponseField> | ||
|
|
||
| <ResponseField name="--registry-auth-id" type="string"> | ||
| ID of the container registry authentication used to pull the image from a private registry. Find the ID with [`runpodctl registry list`](/runpodctl/reference/runpodctl-registry). |
There was a problem hiding this comment.
Documented the new --registry-auth-id create flag; the flag help text in cmd/template/create.go is "container registry auth id (from 'runpodctl registry list')", which is why the description links to the registry reference page.
Source: runpod/runpodctl#290
| </ResponseField> | ||
|
|
||
| <ResponseField name="--port-labels" type="string"> | ||
| New display names for the template's exposed ports, as `port=name` pairs or a JSON object. Pass an empty value (`--port-labels ""`) to remove all port labels. |
There was a problem hiding this comment.
Documented the --port-labels clear-on-update behavior; cmd/template/update.go flag help is "new port labels as port=name pairs or json; pass an empty value to clear" and runUpdate parses an empty value into an empty label set.
Source: runpod/runpodctl#290
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
| </ResponseField> | ||
|
|
||
| <ResponseField name="--registry-auth-id" type="string"> | ||
| New container registry authentication ID for pulling private images. Pass an empty value (`--registry-auth-id ""`) to detach registry credentials from the template. |
There was a problem hiding this comment.
Documented the --registry-auth-id detach-on-update behavior; cmd/template/update.go flag help is "new container registry auth id; pass an empty value to clear" and runUpdate sends an empty ContainerRegistryAuthID when the flag is set to "".
Source: runpod/runpodctl#290
| ### Get template details | ||
|
|
||
| Get detailed information about a specific template, including README, environment variables, and exposed ports: | ||
| Get detailed information about a specific template, including README, environment variables, and exposed ports (with their labels): |
There was a problem hiding this comment.
PR #297 makes GetTemplate backfill portsConfig from GraphQL so template get now echoes port labels; updated the "Get template details" description to mention labels are shown. The backfill lives in internal/api/templates.go.
Source: runpod/runpodctl#297
| </ResponseField> | ||
|
|
||
| <ResponseField name="--port-labels" type="string"> | ||
| Display names for the ports the template exposes, shown next to each port in the Runpod console. Provide comma-separated `port=name` pairs (e.g., `22=ssh,8888=jupyter lab`) or a JSON object (e.g., `{"22":"ssh","8888":"jupyter lab"}`). This flag requires `--ports`, and every labeled port must also appear in `--ports`. The pair form splits on commas, so use the JSON form for any label name that contains a comma. |
There was a problem hiding this comment.
Documented the comma limitation from parsePortLabels in cmd/template/port_labels.go: the port=name pair form splits on , (via strings.Split), so a label name containing a comma must use the JSON form. The flag help text in cmd/template/create.go states the same ("or json when a name contains a comma").
Source: https://github.com/runpod/runpodctl/blob/main/cmd/template/port_labels.go
|
Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.) |
1 participant
Open in Promptless
Documents the
--registry-auth-idand--port-labelsflags onrunpodctl template createandtemplate update, including the port-labelport=name/JSON syntax, the--portsvalidation requirement, the JSON-form requirement for label names containing commas, and the empty-value clear/detach behavior on update. Also notes thattemplate getnow shows port labels. Verified against the final merged runpod/runpodctl PR #297 (re-landed from PR #290).Trigger Events
Tip: Use labels in the Promptless dashboard to categorize suggestions by release or team 🏷️