PSCompletions

✨PSCompletions(psc)✨

简体中文 | Powershell Gallery | GitHub | Gitee | GitCode

Introduce

A completion manager for a better and simpler tab-completion experience in PowerShell, built with Rust and Lua.

• Built-in completion library.
• More powerful completion menu.
• Support multiple languages: en-US, zh-CN, etc.
• Sort completion items dynamically based on command history.

Demo

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
   

How to use

[!TIP]

Run psc update to check the remote status.

• Built-in completion library: add a completion with psc add git.
• Native completion integration: use PowerShell’s native completions.

  • If a command has an official completion, a similar command may be run:

    xxx completion powershell | Out-String | Invoke-Expression
    

  • Register completions with the PowerShell argument completer:

    Register-ArgumentCompleter -Native -CommandName <Name> -ScriptBlock { ... }
    

  • Use other completion libraries, e.g. Carapace

What’s new

See the changelog for details.

Contribution

See the contribution guide for details.

Support

If you like this project, feel free to give it a Star ⭐️ or Donate 💰.

Acknowledgements

• PSReadLine — PowerShell’s editing and completion foundation.
• The completion menu UI is inspired by fzf, PSFzf, and PS-GuiCompletion (v6).

License

MIT © abgox

This site is open source. Improve this page.