Skip to content

WayneJin88888/inshellisense

 
 

Repository files navigation

inshellisense

inshellisense provides IDE style autocomplete for shells. It's a terminal native runtime for autocomplete which has support for 600+ command line tools. inshellisense supports Windows, Linux, & macOS.

demo of inshellisense working

Getting Started

Requirements

  • node >= 16.x
  • node-gyp dependencies installed for your platform (see node-gyp for more details)

Installation

npm install -g @microsoft/inshellisense

Quickstart

After completing the installation, you can run is to start the autocomplete session for your desired shell. Additionally, inshellisense is also aliased under inshellisense after installation.

Usage

Action Command
Start is
Stop exit
Check If Inside Inshellisense Session is -c

Keybindings

All other keys are passed through to the shell. The keybindings below are only captured when the inshellisense suggestions are visible, otherwise they are passed through to the shell as well.

Action Keybinding
Accept Current Suggestion tab
View Next Suggestion
View Previous Suggestion
Dismiss Suggestions esc

Integrations

inshellisense supports the following shells:

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

About

IDE style command line auto complete

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 80.1%
  • Shell 17.1%
  • JavaScript 2.2%
  • PowerShell 0.6%