![\"demo](\"/docs/demo.gif\")
generated by tui-test
\n\n## Getting Started\n\n### Installation\n\n**npm (recommended)**\n\n```shell\nnpm install -g @microsoft/inshellisense\nis init\n```\n\n**homebrew (macOS/linux)**\n\n```shell\nbrew tap microsoft/inshellisense https://github.com/microsoft/inshellisense\nbrew install inshellisense\nis init\n```\n\n### Updating\n\n```shell\nnpm install -g @microsoft/inshellisense # OR brew upgrade inshellisense\nis reinit\n```\n\n### Quickstart\n\nAfter 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.\n\n### Shell Plugin\n\nIf 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:\n\n```shell\n# bash\nis init bash >> ~/.bashrc\n\n# zsh\nis init zsh >> ~/.zshrc\n\n# fish\nis init fish >> ~/.config/fish/config.fish\n\n# pwsh\nis init pwsh | Add-Content $profile\n\n# powershell\nis init powershell | Add-Content $profile\n\n# xonsh\nis init xonsh >> ~/.xonshrc\n\n# nushell\nis init nu | save $nu.env-path --append\n```\n\n> [!NOTE] \n> 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)\n\n### Usage\n\n| Action | Command | Description |\n| ------------------------------------- | ------- | ------------------------------------------------ |\n| Start | `is` | Start inshellisense session on the current shell |\n| Stop | `exit` | Stop inshellisense session on the current shell |\n| Check If Inside Inshellisense Session | `is -c` | Check if shell inside inshellisense session |\n\n#### Keybindings\n\nAll 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](#configuration).\n\n| Action | Keybinding |\n| ------------------------- | -------------- |\n| Accept Current Suggestion | tab |\n| View Next Suggestion | ↓ |\n| View Previous Suggestion | ↑ |\n| Dismiss Suggestions | esc |\n\n## Integrations\n\ninshellisense supports the following shells:\n\n- [bash](https://www.gnu.org/software/bash/)\n- [zsh](https://www.zsh.org/)\n- [fish](https://github.com/fish-shell/fish-shell)\n- [pwsh](https://github.com/PowerShell/PowerShell)\n- [powershell](https://learn.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell) (Windows Powershell)\n- [cmd](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/cmd) _(experimental)_\n- [xonsh](https://xon.sh/)\n- [nushell](https://www.nushell.sh/)\n\n## Configuration\n\nAll configuration is done through a [toml](https://toml.io/) 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](https://json-schema.org/) for the configuration file can be found [here](https://github.com/microsoft/inshellisense/blob/main/src/utils/config.ts).\n\nOn 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.\n\n### Keybindings\n\nYou can customize the keybindings for inshellisense by adding a `bindings` section to your config file. The following is the default configuration for the [keybindings](#keybindings):\n\n```toml\n[bindings.acceptSuggestion]\nkey = \"tab\"\n# shift and control are optional and default to false\nshift = false\ncontrol = false\n\n[bindings.nextSuggestion]\nkey = \"down\"\n\n[bindings.previousSuggestion]\nkey = \"up\"\n\n[bindings.dismissSuggestions]\nkey = \"escape\"\n```\n\nKey names are matched against the Node.js [keypress](https://nodejs.org/api/readline.html#readlineemitkeypresseventsstream-interface) events.\n\n### Alias Expansion\n\nInshellisense supports expanding aliases for bash/zsh shells. You can enable alias expansion in your config file:\n\n```toml\nuseAliases = true\n```\n\n### NerdFonts\n\nIf you are using a [NerdFont](https://www.nerdfonts.com/) patched font, you can enable the NerdFonts support in your config file:\n\n```toml\nuseNerdFont = true\n```\n\n### Max Suggestions\n\nYou can change the maximum number of suggestions displayed in the autocomplete list at one time in your config file:\n\n```toml\nmaxSuggestions = 10\n```\n\n### Active Suggestion Background Color\n\nYou can customize the active suggestion's background with a `#RRGGBB` hex color.\n\n```toml\nactiveSuggestionBackgroundColor = \"#2E7D32\"\n```\n\n### Box Border Style\n\nYou can use square (the default) or rounded corners for suggestion and description boxes.\n\n```toml\nboxBorderStyle = \"rounded\"\n```\n\n## Unsupported Specs\n\nSpecs for the `az`, `gcloud`, & `aws` CLIs are not supported in inshellisense due to their large size.\n\n## Contributing\n\nThis project welcomes contributions and suggestions. Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.\n\nWhen you submit a pull request, a CLA bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Trademarks\n\nThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft\ntrademarks or logos is subject to and must follow\n[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).\nUse of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.\nAny use of third-party trademarks or logos are subject to those third-party's policies.\n","readmeFilename":"README.md","users":{"flumpus-dev":true}}