README

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

 Getting Started

 Installation

npm (recommended)

shell
npm install -g @microsoft/inshellisense
is init


homebrew (macOS/linux)

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


 Updating

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


 Quickstart

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.

 Shell Plugin

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:

shell
 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


 [!NOTE]  
 When updating your shell configuration in the future, make sure the inshellisense plugin is the last command in the file. Including commands after it may break the configuration (ex. initializing your shell plugin manager after the inshellisense plugin)

 Usage

| Action                                | Command | Description                                      |
| ------------------------------------- | ------- | ------------------------------------------------ |
| Start                                 | is    | Start inshellisense session on the current shell |
| Stop                                  | exit  | Stop inshellisense session on the current shell  |
| Check If Inside Inshellisense Session | is -c | Check if shell inside inshellisense session      |

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

| Action                    | Keybinding     |
| ------------------------- | -------------- |
| Accept Current Suggestion | tab |
| View Next Suggestion      | ↓   |
| View Previous Suggestion  | ↑   |
| Dismiss Suggestions       | esc |

 Integrations

inshellisense supports the following shells:

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

 Configuration

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 i