Butterfish CLI Tools

描述

Butterfish 是一套命令行界面 (CLI) 工具，旨在通过将大型语言模型 (LLM) 直接集成到工作流程中，来提高软件工程师和命令行用户的生产力。核心产品 Butterfish Shell 将您现有的 shell (bash, zsh) 转变为一个 AI 驱动的助手。只需用大写字母开头命令，用户就可以向 AI 提出上下文相关的问题，利用 shell 历史记录获取相关帮助，而无需复制粘贴。

此工具充当“shell 包装器”，拦截输入和输出以提供 AI 功能。用户可以询问命令、查询命令失败的原因，甚至可以使用“目标模式”（以 '!' 开头），在这种模式下，AI 作为代理执行命令并实现指定目标，还有一个“不安全目标模式”（以 '!!' 开头）用于自动执行。Butterfish Shell 提供类似 GitHub Copilot 的命令自动补全等功能，并维护对话历史记录，从而能够迭代地优化 AI 生成的命令或响应。

除了 shell 集成之外，Butterfish 还包括其他实用程序，例如直接提示客户端、命令生成器、文件摘要器以及用于管理本地文件嵌入的工具。该项目强调透明度，允许用户通过配置文件查看和自定义发送给 AI 的提示。它支持 OpenAI 兼容的 API，可以使用本地或替代的 LLM 提供商。Butterfish 是开源的，根据 MIT 许可证授权，并欢迎社区贡献。

目标受众包括开发人员、系统管理员以及任何经常使用命令行并希望利用 AI 来加快任务完成、调试和代码生成的人员。其价值主张在于能够无缝集成到现有工作流程中，减少上下文切换，并在需要时提供高上下文的 AI 辅助。

Butterfish CLI Tools的核心功能

• 适用于 bash 和 zsh 的 AI 驱动的 shell 集成

• 使用 shell 历史记录进行上下文 AI 提示

• 类似 GitHub Copilot 的命令自动补全

• 用于 AI 驱动的命令执行的目标模式

• 用于自动命令执行的不安全目标模式

• 可自定义的 AI 提示和系统消息

• 支持 OpenAI 兼容的 API 和本地模型

• 文件摘要和文本嵌入功能

• AI 请求和响应的透明日志记录

• MIT 许可证下的开源

如何使用 Butterfish CLI Tools？

1. 1

   安装：在 macOS 上使用 Homebrew (`brew install bakks/bakks/butterfish`) 或 `go install`。

2. 2

   身份验证：运行 `butterfish shell`，并在提示时粘贴您的 OpenAI API 密钥。

3. 3

   配置：可选地，在您的 shell 的 rc 文件中将 `butterfish` 别名为 `bf` 以方便使用。

4. 4

   使用 Shell 模式：用大写字母开头命令以进行 AI 提示，或使用 '!' 进入目标模式。

5. 5

   自动建议：按 Tab 键接受 AI 建议的命令补全。

6. 6

   调试：提出上下文问题，例如“为什么该命令失败了？”

7. 7

   摘要：使用 `butterfish summarize <files>` 获取文件的语义摘要。

Butterfish CLI Tools的使用案例

• AI Shell 助手
• 命令生成
• 文件摘要
• 代码调试
• 上下文提示
• 代理任务执行
• 本地 LLM 集成
• 文本嵌入管理

Butterfish CLI Tools的常见问题

• 什么是 Butterfish？它有什么作用？

  Butterfish 是一套 CLI 工具，可将 AI 提示集成到您的命令行工作流程中，提供 AI 辅助的 shell 命令、自动补全和面向目标的任务执行等功能。

• Butterfish Shell 如何为我的终端添加 AI 超能力？

  Butterfish Shell 包装了您现有的 shell (bash, zsh)，允许您通过以大写字母开头命令来提示 AI。它使用您的 shell 历史记录来提供上下文 AI 帮助。

• Butterfish 能帮助我调试命令吗？

  是的，在命令执行后，您可以提出上下文问题，例如“为什么该命令失败了？”，Butterfish 将使用 AI 来帮助诊断问题。

• Butterfish 中的目标模式是什么？

  目标模式（以 '!' 开头）允许 AI 作为代理。您提供一个目标，AI 将建议并执行命令来实现它，并使用您的 shell 历史记录作为上下文。

• 如何安装 Butterfish？

  Butterfish 可以在 macOS 和 Linux 上安装。在 macOS 上，您可以使用 Homebrew (`brew install bakks/bakks/butterfish`)。或者，您可以使用 `go install`。

• Butterfish 需要 OpenAI API 密钥吗？

  是的，Butterfish 默认使用 OpenAI API。在首次调用 `butterfish shell` 时，您需要提供您的 OpenAI API 密钥。

• 我可以使用 Butterfish 与本地 LLM 或其他 API 提供商一起使用吗？

  是的，Butterfish 支持 OpenAI 兼容的 API。您可以使用 `--base-url` 标志指向本地模型或其他兼容的 API 端点。

• Butterfish 是开源的吗？

  是的，Butterfish 是一个开源项目，根据 MIT 许可证授权。

• 除了 shell 包装器之外，Butterfish 还提供了哪些其他实用程序？

  Butterfish 还包括用于直接 LLM 提示、生成 shell 命令、语义摘要文件以及管理本地文件嵌入的实用程序。

• Butterfish 如何处理长命令输出或历史记录？

  Butterfish 在 API 请求的 token 限制内管理历史记录。长命令输出将被截断到可配置的 token 限制，较旧的历史记录项可能会超出上下文窗口。

• 我可以自定义发送给 AI 的提示吗？

  是的，Butterfish 使提示透明且可配置。您可以编辑位于 `~/.config/butterfish/prompts.yaml` 的提示包装器。

• 什么是“不安全目标模式”？

  不安全目标模式（以 '!!' 开头）允许 AI 在未经确认的情况下执行命令。此模式可能存在危险，应谨慎使用。