docs(complete): Fix instructions for sourcing PowerShell completions#6181
Merged
epage merged 2 commits intoclap-rs:masterfrom Nov 10, 2025
Merged
docs(complete): Fix instructions for sourcing PowerShell completions#6181epage merged 2 commits intoclap-rs:masterfrom
epage merged 2 commits intoclap-rs:masterfrom
Conversation
fbf9b88 to
292ef07
Compare
epage
reviewed
Nov 10, 2025
The previous instructions were wrong in that they set the `COMPLETE`
env var only while the `$PROFILE` script was written. This was akin to
COMPLETE=bash echo "source <(your_program)" >> ~/.bashrc
whereas the corrected version sets `COMPLETE` as part of the `$PROFILE`
script, mirroring the instructions for sourcing completion in the other
shells.
Extending `$PROFILE` in this way also requires that scripts are allowed
to be executed. This requires changing the execution policy from its
default value `Restricted` on Windows. There's no such issue when using
PowerShell on macOS or Linux.
292ef07 to
e495ab1
Compare
Member
|
Thanks! |
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.
The previous instructions were wrong in that they set the
COMPLETEenv var only while the$PROFILEscript was written. This was akin towhereas the corrected version sets
COMPLETEas part of the$PROFILEscript, mirroring the instructions for sourcing completion in the other shells.Extending
$PROFILEin this way also requires that scripts are allowed to be executed. This requires changing the execution policy from its default valueRestrictedon Windows. There's no such issue when using PowerShell on macOS or Linux.