Sync command reference with current CLI options - #2265
Merged
katiewasnothere merged 2 commits intoSep 22, 2026
Merged
Conversation
katiewasnothere
approved these changes
Sep 18, 2026
Code Coverage
|
katiewasnothere
approved these changes
Sep 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type of Change
Motivation and Context
The command reference still documents a registry scheme value the CLI no longer accepts. #2100 removed the
autoscheme in code only, so all seven--schemelines and the "Behavior ofauto" block undercontainer rundisagree withcontainer run --help, which printsOne of (http, https) (default: https). #1744 added--kernel-argtocontainer runandcontainer createwithout a reference entry, sogrep -rn kernel-arg docsfinds nothing. The shell completions note links to apple.github.io/swift-argument-parser, which now returns 404 for every path including its root, so it now points at the article's source in apple/swift-argument-parser, which returns 200. #1571 proposed a CI check to keep this file in sync with--helpbut was closed unmerged, so the drift is still here.Testing
Docs only. Compared each edited line against
--helpforrun,create,image pull,image push,registry login, andmachine createfrom a build of main, then checkedgrep -n "https, auto" docs/command-reference.md(no output),grep -c "default: https)" docs/command-reference.md(7), andgrep -c "kernel-arg" docs/command-reference.md(2).container k8s createuses the sameFlags.Registrygroup (ContainerK8s/Commands/K8sCreate.swift), so its line follows.