Skip to content

bergmeister/posh-cli

Repository files navigation

posh-cli License: MIT posh-cli

Build Status

A meta module to bootstrap CLI tab completion PowerShell modules.

Usage

Install-Module -Name posh-cli -Repository PSGallery
Install-TabCompletion

Install the posh-cli module and calling Install-TabCompletion installs required modules that tab completion to the CLIs available on your system. It also imports the module so that you can start using it and adds such a call to your PowerShell $PROFILE as well.

You can call the Install-TabCompletion cmdlet also to update those modules at a later time. The list of modules is stored remotely in the cli-modules-v1.json file, therefore you should not need to update posh-cli itself unless new capabilities become available that you want to use. Only non-breaking changes will be made to this JSON file.

Overview

The module analyses the installed CLIs and installs modules from the PSGallery that help with the tab completion. It automatically executes and adds the necessary calls for initialisation of the installed tab completion modules to your $PROFILE.

Currently it is aware of the following modules.

CLI PowerShell tab completion module Remarks
cargo posh-cargo
dcos posh-dcos
dotnet posh-dotnet
docker DockerCompletion
gcloudsdk GcloudTabComplete Minimum PowerShell Version: 5.1
git posh-git
mvn MavenAutoCompletion Minimum PowerShell Version: 6.0
npm npm-completion
scoop scoop-completion
vsts posh-vsts-cli
yarn yarn-completion

Should new modules be added to the list, then just calling Install-TabCompletion is sufficient as the list is stored remotely and does not require an update of posh-cli itself.