microsoft/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.

_{^{generated by tui-test}}

npm (recommended)

npm install -g @microsoft/inshellisense
is init

homebrew (macOS/linux)

brew tap microsoft/inshellisense https://github.com/microsoft/inshellisense
brew install inshellisense
is init

npm install -g @microsoft/inshellisense # OR brew upgrade inshellisense
is reinit

After completing the installation, run is doctor to verify your installation was successful. You can run is to start the autocomplete session for your desired shell. Additionally, inshellisense is also aliased under inshellisense after installation.

If you'd like to automatically start inshellisense when you open your shell, run the respective command for your shell. After running the command, inshellisense will automatically open when you start any new shell session:

# bash
is init bash >> ~/.bashrc

# zsh
is init zsh >> ~/.zshrc

# fish
is init fish >> ~/.config/fish/config.fish

# pwsh
is init pwsh | Add-Content $profile

# powershell
is init powershell | Add-Content $profile

# xonsh
is init xonsh >> ~/.xonshrc

# nushell
is init nu | save $nu.env-path --append

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. These can be customized in the config.

inshellisense supports the following shells:

• bash
• zsh
• fish
• pwsh
• powershell (Windows Powershell)
• cmd (experimental)
• xonsh
• nushell

All configuration is done through a toml file. You can create this file at ~/.inshellisenserc or $XDG_CONFIG_HOME/inshellisense/rc.toml. When XDG_CONFIG_HOME is unset, empty, or not an absolute path, the XDG configuration path defaults to ~/.config/inshellisense/rc.toml. The JSON schema for the configuration file can be found here.

On new Unix-like installations, generated resources are stored under $XDG_DATA_HOME/inshellisense. When XDG_DATA_HOME is unset, empty, or non-absolute, it defaults to ~/.local/share as defined by the XDG specification. Existing installations continue using ~/.inshellisense when that directory is present so current shell plugins keep working; Windows also keeps using that location. Running is reinit migrates legacy resources to the XDG data directory.

You can customize the keybindings for inshellisense by adding a bindings section to your config file. The following is the default configuration for the keybindings:

[bindings.acceptSuggestion]
key = "tab"
# shift and control are optional and default to false
shift = false
control = false

[bindings.nextSuggestion]
key = "down"

[bindings.previousSuggestion]
key = "up"

[bindings.dismissSuggestions]
key = "escape"

Key names are matched against the Node.js keypress events.

Inshellisense supports expanding aliases for bash/zsh shells. You can enable alias expansion in your config file:

useAliases = true

If you are using a NerdFont patched font, you can enable the NerdFonts support in your config file:

useNerdFont = true

You can change the maximum number of suggestions displayed in the autocomplete list at one time in your config file:

maxSuggestions = 10

You can customize the active suggestion's background with a #RRGGBB hex color.

activeSuggestionBackgroundColor = "#2E7D32"

You can use square (the default) or rounded corners for suggestion and description boxes.

boxBorderStyle = "rounded"

Specs for the az, gcloud, & aws CLIs are not supported in inshellisense due to their large size.

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.

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.