Repository navigation
docs: document shell completion, Windows support and the new conventions - #101
Merged
Merged
Conversation
marcossevilla
previously approved these changes
Oct 21, 2026
marcossevilla
force-pushed
the
docs/completion-and-windows-support
branch
3 times, most recently
from
October 28, 2026 12:13
8c8d31f to
14a5f4d
Compare
The CLI has shipped install-completion-files since it extended CompletionCommandRunner, but cli_completion hides those commands from --help, so nothing told anyone they existed. Windows is stated plainly rather than left open: macOS and Linux are supported, Windows through WSL, and jq has to be on PATH because the Codex, Copilot and Antigravity hooks are bash scripts. Native Windows and Git Bash are called untested, because the CLI builds paths with the host separator while those scripts expect POSIX ones. AGENTS.md and CONTRIBUTING.md pick up release-please, the link check, the shared test harness and the constructor doc rule.
marcossevilla
force-pushed
the
docs/completion-and-windows-support
branch
from
October 28, 2026 12:28
14a5f4d to
a2470ec
Compare
marcossevilla
approved these changes
Oct 28, 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.
Description
Stack 4 of 5 for #68. Base:
chore/release-please-and-repo-files(#100).The CLI has shipped
install-completion-filesever since it extendedCompletionCommandRunner, butcli_completionhides those commands from--help, so nothing told anyone they existed.Windows is stated plainly rather than left open: macOS and Linux are supported, Windows through WSL, and
jqhas to be onPATHbecause the Codex, Copilot and Antigravity hooks are bash scripts. Native Windows and Git Bash are called untested, because the CLI builds paths with the host separator while those scripts expect POSIX ones.The package README also stopped telling people to
dart pub global activate vgv_ai_cli, which cannot work while the package ispublish_to: none.Type of Change
🤖 Generated with Claude Code