docs: document shell completion setup in the README - #974
Merged
xarmian merged 1 commit intoJul 20, 2026
Conversation
Adds a Shell completion section to the CLI Reference covering install steps for bash, zsh, fish, and PowerShell, and calls out the dynamic completions that already exist (collection names, --workspace, --status/--priority). Closes PerpetualSoftware#905
Collaborator
|
Thanks for this, @dchaudhari7177! 🙏 Cross-checked every claim against the code — the supported shells match |
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
2 participants
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.
Closes #905
Adds a Shell completion section to the CLI Reference (right after the
--format/--workspacenote) with install one-liners for bash, zsh, fish, and PowerShell, matching thecompletioncommand's actualValidArgsincmd/pad/main.go.Also mentions the dynamic completions that already ship so users know the payoff: collection args (
completeCollectionNamesviaValidArgsFunctionincmd/pad/cmd_item.go),--workspace(RegisterFlagCompletionFuncincmd/pad/main.go), and--status/--priority.Docs-only change.