/inshellisense

IDE style command line auto complete

Primary LanguageTypeScriptMIT LicenseMIT

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

Installation

npm install -g @microsoft/inshellisense

Quickstart

After completing the installation, you can already run inshellisense --shell <shell> to start the autocomplete session for your desired shell. Additionally, you can bind inshellisense to a keybinding of CTRL+a by running the below command. This brings the added advantages of automatically starting the autocomplete session with your current shell and injecting any accepted command into your shell's history.

inshellisense bind

Additionally, inshellisense is also aliased under is after installation for convenience.

Integrations

inshellisense supports the following shells:

Contributing

Important

inshellisense is currently undergoing a major redesign, see #79, so note that some contributions will not be merged if they are modifying functionality targeted by the redesign.

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 opencode@microsoft.com 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.