Skip to content

PSCompletions (psc)

Introduce

socialify

Star ⭐️ or Donate 💰 if you like it!

TIP

  • PowerShell(pwsh): A cross-platform PowerShell (Core). Start it by running pwsh/pwsh.exe.
  • Windows PowerShell: A PowerShell (Desktop) which is built-in on Windows system. Start it by running powershell/powershell.exe.
  • They can both use PSCompletions, but PowerShell(pwsh) is more recommended.

A completion manager for a better and simpler tab-completion experience in PowerShell.

Demo

demo

What's new

See the Changelog for details.

FAQ

See the FAQ.

Contribution

See the Contribution Guide for details.

How to install

  1. Install the module.

  2. Import the module.

    powershell
    Import-Module PSCompletions

TIP

  • If you use . $Profile, please run psc to reload the module's key bindings and data.
  • Refer to: Source profile

How to use

  • Use the built-in completion library, like git.

    1. Add completion: psc add git
    2. Then you can enter git, press Space and Tab key to get command completion.
  • Use official completion or other completion libraries.

    • If there is an official completion for xxx, a similar command may be run:

      powershell
      xxx completion powershell | Out-String | Invoke-Expression
    • Work with other completion libraries: argc-completions, Carapace

    • For more details, please refer to menu enhance

  • Use PSFzf as the completion menu, refer to Work with PSFzf.

Acknowledgements

  • PSReadLine: A built-in module in PowerShell, which is used to enhance command line editing experience.
    • PSCompletions uses Set-PSReadLineKeyHandler and Get-PSReadLineOption.
  • PS-GuiCompletion: GUI-style tab-completion menu for PowerShell.

Available Completions