docs: update shell completions instructions in README#1877
Merged
tmccombs merged 1 commit intosharkdp:masterfrom Jan 30, 2026
Merged
docs: update shell completions instructions in README#1877tmccombs merged 1 commit intosharkdp:masterfrom
tmccombs merged 1 commit intosharkdp:masterfrom
Conversation
tmccombs
requested changes
Jan 30, 2026
Collaborator
tmccombs
left a comment
tmccombs
left a comment
There was a problem hiding this comment.
The current instructions are for installation from the prebuilt zip and tar files on the releases page.
I'm fine with adding documentation for generating completions from fd, but I'd also like to keep the current instructions (but maybe make it more clear that is in the releases archives, not the repo).
Add documentation for generating completions using fd --gen-completions, while keeping and clarifying the existing instructions for pre-built completions from release archives. - Clarify that pre-built completions are in release archives (autocomplete dir) - Add new section for generating completions with fd --gen-completions - Include examples for bash, zsh, fish, and powershell
littleKitchen
force-pushed
the
docs/update-completions-readme
branch
from
8d46c35 to
4410dda
Compare
tmccombs
approved these changes
Jan 30, 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
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.
Fixes #1815
Summary
Updated the shell completions section in README.md to use the modern
fd --gen-completionsmethod instead of referencing non-existent files.Changes
The previous instructions referenced files in an 'autocomplete' directory that don't exist in the repository. This PR updates all shell instructions to use the
--gen-completionsflag:fd --gen-completions bash > ~/.local/share/bash-completion/completions/fdfd --gen-completions zsh > ~/.zfunc/_fdfd --gen-completions fish > ~/.config/fish/completions/fd.fishfd --gen-completions powershellAlso mentioned that pre-generated zsh completions are available in
contrib/completion.