Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vNugglets/PowerShellArgumentCompleters
Some work on making Argument Completers for PowerShell cmdlets (like those from VMware PowerCLI)
https://github.com/vNugglets/PowerShellArgumentCompleters
argumentcompleter powercli powershell tab-completion vmware
Last synced: 3 months ago
JSON representation
Some work on making Argument Completers for PowerShell cmdlets (like those from VMware PowerCLI)
- Host: GitHub
- URL: https://github.com/vNugglets/PowerShellArgumentCompleters
- Owner: vNugglets
- License: mit
- Created: 2019-07-31T21:58:13.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-02-16T23:31:46.000Z (over 2 years ago)
- Last Synced: 2024-05-23T00:30:22.531Z (6 months ago)
- Topics: argumentcompleter, powercli, powershell, tab-completion, vmware
- Language: PowerShell
- Size: 1.11 MB
- Stars: 14
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: ReadMe.md
- License: License
Awesome Lists containing this project
- jimsghstars - vNugglets/PowerShellArgumentCompleters - Some work on making Argument Completers for PowerShell cmdlets (like those from VMware PowerCLI) (PowerShell)
README
## Argument Completers for some PowerShell module cmdlets
A collection of some PowerShell argument completers for various cmdlets from some PowerShell modules:
| Argument Completer Script | Description | PSGallery Info |
|---------------------------|-------------|----------------|
| Register-VNActiveDirectoryArgumentCompleter.ps1 | Completers for Microsoft's `ActiveDirectory` PowerShell module | [](https://www.powershellgallery.com/packages/Register-VNActiveDirectoryArgumentCompleter) [](https://www.powershellgallery.com/packages/Register-VNActiveDirectoryArgumentCompleter) |
| Register-VNAWSArgumentCompleter.ps1 | Completers for some of the AWS PowerShell modules `AWS.Tools.*`, and the monolithic `AWSPowerShell*` | [](https://www.powershellgallery.com/packages/Register-VNAWSArgumentCompleter) [](https://www.powershellgallery.com/packages/Register-VNAWSArgumentCompleter) |
| Register-VNVMwarePowerCLIArgumentCompleter.ps1 | Completers for VMware PowerShell module `VMware.PowerCLI` | [](https://www.powershellgallery.com/packages/Register-VNVMwarePowerCLIArgumentCompleter) [](https://www.powershellgallery.com/packages/Register-VNVMwarePowerCLIArgumentCompleter) |
Contents:
- [What is Argument Completing?](#whatIsArgCompleting)
- [Getting Started](#gettingStarted)
- [Deeper Info](#deeperInfo)
## What is Argument Completing?
Background: PowerShell argument completers are a way to enable tab-completion of cmdlet parameter values. These can be from static sources, live sources -- whatever you can imagine. Here are some examples of argument completing for a few VMware PowerCLI cmdlets' parameters:
## Getting Started
The [docs](./docs) for this project have the information about getting started with using argument completers. Check them out.
One can use a scriptblock of goodness in order to generate the completion results. So, for example:
``` PowerShell
## with a proper argument completer for the -Name parameter, the following cycles through VMs whose name match the given string, live, from the given virtual infrastructure
Get-VM -Name matt
```
By registering an argument completer scriptblock for a particular cmdlet and parameter, at tab-completion time, that completer generates a list of completion results (assuming any matches), through which the user can subsequently cycle via further `Tab`-ing. The workflow:
- register argument completer scriptblock for a cmdlet/parameter pair (say, by runnig a script that has argument completers in it, and that registers them for cmdlet/parameter pairs)
- for a registered argument completer, the argument scriptblock is executed one time for the first press of the `Tab` key, creating a list of completion results (if any)
- each subsequent press of `Tab` cycles through the list of completions results (assuming that there is more than one)
- one can also see the whole list of completion results, assuming they are in an environment that supports such things, like in something with IntelliSense, or in a PowerShell session with the `PSReadline` module loaded
A bit deeper explanation on the behavior resides at [https://github.com/mtboren/PowerCLIFeedback/blob/master/PowerCLISuggestions.md](https://github.com/mtboren/PowerCLIFeedback/blob/master/PowerCLISuggestions.md) in the "Support Natural PowerShell Interactive Behavior" section
For a bit more information about PowerShell argument completers (though there is not extensive official documentation on argument completers themselves to be found, yet), see [Register-ArgumentCompleter
](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/register-argumentcompleter)