inshellisense

inshellisense 为 shell 提供类似 IDE 的自动完成功能。它是 autocomplete 的终端原生运行时，支持 600 多个命令行工具。inshellisense 支持 Windows、Linux 和 macOS。

入门

要求

• Node.js 20.X、18.X、16.X（16.6.0 及以上）

安装

npm install -g @microsoft/inshellisense

快速开始

安装完成后，你可以运行 is 为你想要的 shell 启动自动完成会话。此外，安装后 inshellisense 也可以通过 inshellisense 别名调用。

Shell 插件

如果你想在打开 shell 时自动启动 inshellisense，请运行适用于你的 shell 的相应命令。运行命令后，inshellisense 将在你启动任何新的 shell 会话时自动打开：

# bash
is init bash >> ~/.bashrc

# zsh
is init zsh >> ~/.zshrc

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

# pwsh
is init pwsh >> $profile

# powershell
is init powershell >> $profile

# xonsh
is init xonsh >> ~/.xonshrc

# nushell
is init nu >> $nu.env-path

将来更新 shell 配置时，请确保 inshellisense 插件是文件中的最后一条命令。

使用方法

快捷键

所有其他按键都会传递给 shell。以下快捷键仅在 inshellisense 建议可见时捕获，否则也会传递给 shell。这些可以在配置中自定义。

集成

inshellisense 支持以下 shell：

• bash
• zsh
• fish
• pwsh
• powershell（Windows Powershell）
• cmd（实验性）
• xonsh
• nushell

配置

所有配置都通过 toml 文件完成。你可以在 ~/.inshellisenserc 或符合 XDG 标准的 ~/.config/inshellisense/rc.toml 创建此文件。配置文件的 JSON schema 可以在这里找到。

快捷键

你可以通过在配置文件中添加 bindings 部分来自定义 inshellisense 的快捷键。以下是快捷键的默认配置：

[bindings.acceptSuggestion]
key = "tab"
# shift 和 tab 是可选的，默认为 false
shift = false
ctrl = false

[bindings.nextSuggestion]
key = "down"

[bindings.previousSuggestion]
key = "up"

[bindings.dismissSuggestions]
key = "escape"

键名与 Node.js keypress 事件匹配。

贡献

本项目欢迎贡献和建议。大多数贡献都要求你同意贡献者许可协议（CLA），声明你有权并确实授予我们使用你的贡献的权利。有关详细信息，请访问 https://cla.opensource.microsoft.com。

当你提交拉取请求时，CLA 机器人会自动确定你是否需要提供 CLA，并适当地修饰 PR（例如，状态检查、评论）。只需按照机器人提供的说明操作即可。你只需在所有使用我们 CLA 的仓库中执行一次此操作。

本项目已采用 Microsoft 开源行为准则。 有关更多信息，请参阅行为准则常见问题解答或 联系 opencode@microsoft.com 获取任何其他问题或意见。

商标

本项目可能包含项目、产品或服务的商标或徽标。Microsoft 商标或徽标的授权使用必须遵循 Microsoft 商标和品牌指南。 在本项目的修改版本中使用 Microsoft 商标或徽标不得造成混淆或暗示 Microsoft 赞助。 任何第三方商标或徽标的使用都受制于这些第三方的政策。