PSCompletions

✨PSCompletions(psc)✨

简体中文 | English | Powershell Gallery | Github | Gitee

---

Star ⭐️ or Donate 💰 if you like it!

Introduce

[!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.

• Built-in completion library.
• More powerful module completion menu.
• Support multiple languages: en-US, zh-CN, etc.
• Sort completion items dynamically based on command history.
• Work with other tools.
  • argc-completions
  • Carapace
  • PSFzf

Demo

[!Tip]

• If it cannot be displayed here, you can check it on the official website.
• Click to view the videos on Bilibili.

What’s new

See the Changelog for details.

Contribution

See the Contribution Guide for details.

How to install

1. Install the module.

   • Install-Module

     Install-Module PSCompletions
     

   • Install-PSResource

     Install-PSResource PSCompletions
     

   • Scoop

     • Add the abyss bucket via Github or Gitee.

     • Install it.

       scoop install abyss/abgox.PSCompletions
       

2. Import the module.

   Import-Module PSCompletions
   

[!Tip]

• If you use . $Profile, please run psc to reload the module’s key bindings and data.
• Refer to: https://pscompletions.abgox.com/docs/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:

    xxx completion powershell | Out-String | Invoke-Expression
    

  • Work with other completion libraries: argc-completions, Carapace

  • For more details, please refer to: https://pscompletions.abgox.com/docs/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.
  • The module completion menu of PSCompletions is inspired by it.

Available Completions

• English
• 简体中文

This site is open source. Improve this page.