Skip to main content
warning

本教程由社区贡献,不属于 Open WebUI 团队官方支持。它仅作为如何针对特定用例自定义 Open WebUI 的演示。想要贡献?请查看 贡献教程。

在 iTerm2 中使用您的 Open WebUI 模型

您可以在 iTerm2 AI 插件中使用您的 Open WebUI 模型。本指南将向您展示如何进行必要的配置。

为什么要使用 iTerm2 AI 插件?​

每当您忘记某个命令或需要为重复性任务编写快速 bash 脚本时,您可能已经在尝试使用 AI 的回答了。为了简化这一工作流程,iTerm2 AI 插件允许您向指定的 AI 提供商或您的 Open WebUI 发送请求。

为什么要连接到您的 Open WebUI 实例?​

Open WebUI 通过其 API 端点 (API Endpoints) 提供了一种简单直接的方式与您的大语言模型 (LLM) 进行交互。如果您在本地运行自己的 LLM,这将特别有用。此外,您还可以利用所有已实现的功能、监控和其他能力。

前提条件​

1. 下载 iTerm2 AI 插件​

如果您还没有安装 iTerm2 AI 插件,您需要先从官方页面下载它。 解压文件并将应用程序移动到您的 应用程序 (Applications) 文件夹中。

2. 生成您的 Open WebUI API 密钥​

要通过您的 Open WebUI 实例进行身份验证,您需要生成一个 API 密钥。 请按照本指南中的说明进行创建。

配置​

打开您的 iTerm2 终端,从 iTerm2 菜单中导航至 设置 (Settings) (⌘,),然后选择 AI 选项卡。

设置前的 iterm2 菜单

验证已安装的插件​

安装 iTerm2 AI 插件后,请验证 Plugin 部分是否显示 Plugin installed and working ✅。


同意生成式 AI 功能​

在 Consent 部分,勾选 Enable generative AI features 复选框以表示同意。


设置 API 密钥​

在 API Key 字段中输入您之前创建的 Open WebUI API 令牌。


可选:自定义您的提示词 (Prompt)​

如果您想向 LLM 发送专门的提示词,请随意编辑 Prompt template。

原始提示词示例:

Return commands suitable for copy/pasting into \(shell) on \(uname). Do
NOT include commentary NOR Markdown triple-backtick code blocks as your
whole response will be copied into my terminal automatically.

The script should do this: \(ai.prompt)

您可以在 iTerm2 文档中阅读更多关于 iTerm2 提示词的信息。


选择您的 LLM​

由于 iTerm2 AI 插件不会自动列出您的自定义模型,您需要手动添加您喜欢的模型。 在您的 Open WebUI 实例中,导航至 管理员面板 (Admin Panel) > 设置 (Settings) > 模型 (Models),然后点击您喜欢的 LLM。 在用户给定的名称下方,您会找到需要输入到 iTerm2 中的实际模型名称(例如,名称:Gemma3 - 模型名称:/models/gemma3-27b-it-Q4_K_M.gguf)。


调整 Token 数量​

在这里设置您喜欢的 Token 数量。通常,您的推理工具已经设置了限制。


调整 URL​

这是一个关键步骤:您需要将 iTerm2 AI 插件的请求定向到您的 Open WebUI 实例。 如果实例托管在某处,请使用实际域名(例如 https://example.com/api/chat/completions);或者使用您的本地设置(例如 http://localhost:8080/api/chat/completions)。 您可以在 API 端点指南 (API Endpoints guide) 中找到更多关于 URL 的信息。


传统 Completions API (Legacy Completions API)​

Open WebUI 不需要此设置,不过在原始指南中有更多相关信息。


设置完成后,AI 部分将如下所示:

设置后的 iterm2 菜单

使用方法​

在您的终端会话中,按下 command + y (⌘y) 打开提示词输入字段。输入您的提示词,然后点击 OK 按钮或使用 shift + enter (⇧⌤) 发送。

iterm2 提示词窗口


这将带您回到终端,并在会话框架中绑定一个附加窗口。查询结果将显示在这个浮层中。要将命令发送到终端,请将光标移动到目标行并使用 shift + enter (⇧⌤)。

info

回复可能包含多行。如果是这样,您可以使用箭头键进行导航,并根据需要编辑命令。

iterm2 结果窗口