Merge pull request #1139 from kirinnee/master
Added manual and script for PowerShell autocomplete
This commit is contained in:
commit
3629eb8550
9
autocomplete/powershell_autocomplete.ps1
Normal file
9
autocomplete/powershell_autocomplete.ps1
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
$fn = $($MyInvocation.MyCommand.Name)
|
||||||
|
$name = $fn -replace "(.*)\.ps1$", '$1'
|
||||||
|
Register-ArgumentCompleter -Native -CommandName $name -ScriptBlock {
|
||||||
|
param($commandName, $wordToComplete, $cursorPosition)
|
||||||
|
$other = "$wordToComplete --generate-bash-completion"
|
||||||
|
Invoke-Expression $other | ForEach-Object {
|
||||||
|
[System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
|
||||||
|
}
|
||||||
|
}
|
@ -30,6 +30,7 @@ cli v2 manual
|
|||||||
+ [ZSH Support](#zsh-support)
|
+ [ZSH Support](#zsh-support)
|
||||||
+ [ZSH default auto-complete example](#zsh-default-auto-complete-example)
|
+ [ZSH default auto-complete example](#zsh-default-auto-complete-example)
|
||||||
+ [ZSH custom auto-complete example](#zsh-custom-auto-complete-example)
|
+ [ZSH custom auto-complete example](#zsh-custom-auto-complete-example)
|
||||||
|
+ [PowerShell Support](#powershell-support)
|
||||||
* [Generated Help Text](#generated-help-text)
|
* [Generated Help Text](#generated-help-text)
|
||||||
+ [Customization](#customization-1)
|
+ [Customization](#customization-1)
|
||||||
* [Version Flag](#version-flag)
|
* [Version Flag](#version-flag)
|
||||||
@ -1225,6 +1226,23 @@ source path/to/autocomplete/zsh_autocomplete
|
|||||||
#### ZSH custom auto-complete example
|
#### ZSH custom auto-complete example
|
||||||
![](/docs/v2/images/custom-zsh-autocomplete.gif)
|
![](/docs/v2/images/custom-zsh-autocomplete.gif)
|
||||||
|
|
||||||
|
#### PowerShell Support
|
||||||
|
Auto-completion for PowerShell is also supported using the `autocomplete/powershell_autocomplete.ps1`
|
||||||
|
file included in this repo.
|
||||||
|
|
||||||
|
Rename the script to `<my program>.ps1` and move it anywhere in your file system.
|
||||||
|
The location of script does not matter, only the file name of the script has to match
|
||||||
|
the your program's binary name.
|
||||||
|
|
||||||
|
To activate it, enter `& path/to/autocomplete/<my program>.ps1`
|
||||||
|
|
||||||
|
To persist across new shells, open the PowerShell profile (with `code $profile` or `notepad $profile`)
|
||||||
|
and add the line:
|
||||||
|
```
|
||||||
|
& path/to/autocomplete/<my program>.ps1
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Generated Help Text
|
### Generated Help Text
|
||||||
|
|
||||||
The default help flag (`-h/--help`) is defined as `cli.HelpFlag` and is checked
|
The default help flag (`-h/--help`) is defined as `cli.HelpFlag` and is checked
|
||||||
|
Loading…
Reference in New Issue
Block a user