-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add markdown file explaining support for PowerShell
- Loading branch information
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Generating PowerShell Completions For Your Own cobra.Command | ||
|
||
Cobra can generate PowerShell completion scripts. Users need PowerShell version 5.0 or above, which comes with Windows 10 and can be downloaded separately for Windows 7 or 8.1. They can then write the completions to a file and source this file from their PowerShell profile, which is referenced by the `$Profile` environment variable. See `Get-Help about_Profiles` for more info about PowerShell profiles. | ||
|
||
# What's supported | ||
|
||
- Completion for subcommands using their `.Short` description | ||
- Completion for non-hidden flags using their `.Name` and `.Shorthand` | ||
|
||
# What's not yet supported | ||
|
||
- Command aliases | ||
- Required, filename or custom flags (they will work like normal flags) | ||
- Custom completion scripts |