Bito CLI

Bito CLI（命令行界面）为 Bito AI 聊天功能提供了一个命令行接口。随着时间的推移，CLI 将会增加更多功能和新的命令选项，以支持复杂的自动化和工作流。

目前这是一个非常早期的 Alpha 版本。我们非常希望收到您对新功能或改进建议的反馈。请发送邮件至 founders@bito.ai 或 support@bito.ai。

先决条件

终端

• Bash（适用于 Mac 和 Linux）
• CMD（适用于 Windows）

使用 Bito CLI

• 执行聊天： 在命令提示符中运行 bito 命令即可开始。您可以询问任何需要帮助的问题，例如 awk 命令如何打印第一列和最后一列。

  注意： Bito CLI 支持多行输入的长提示。要完成并提交提示，请按 Ctrl+D。Enter/Return 键会在输入中添加新行。

• 退出 Bito CLI： 要退出 Bito CLI，输入 quit 并按下 Ctrl+D。

• 终止： 按下 Ctrl+C 可以终止 Bito CLI。

开始使用

观看下面的视频，了解如何开始使用 Bito CLI：

https://user-images.githubusercontent.com/61789690/236821693-11705a17-e2a8-4f7c-8921-a47e75c81794.mp4

安装 Bito CLI（推荐）

我们建议您使用以下方法安装 Bito CLI。

MAC 和 Linux

sudo curl https://alpha.bito.ai/downloads/cli/install.sh -fsSL | bash （curl 会始终下载最新版本）

Archlinux

Arch 及其基于 Arch 的发行版用户可以从 AUR 安装。

yay -S bito-cli 或 paru -S bito-cli

使用 Homebrew：

1. 在使用 Homebrew 之前，请确保您已使用此处提供的卸载脚本卸载所有先前安装的 Bito CLI 版本：卸载 Bito CLI。
2. 完成上述操作后，您可以使用以下命令通过 Homebrew 安装 Bito CLI：
   • 首先使用 brew tap gitbito/bitocli 添加 CLI 仓库，这只需执行一次，无需每次都进行。
   • 然后可以使用以下命令安装 Bito CLI：
     • brew install bito-cli — 这将根据您的机器架构安装 Bito CLI。
   • 若要将 Bito CLI 更新到最新版本，请使用以下命令：
     • 请务必在升级前始终运行 brew update，以避免出现错误。
     • brew update — 这将更新所有必要的软件包后再进行升级。
     • brew upgrade bito-cli — 执行完上述步骤后，此命令会将 Bito CLI 更新到最新版本。
   • 若要卸载 Bito CLI，您可以使用上述链接中的卸载命令，或者使用以下命令：
     • brew uninstall bito-cli — 这将从您的系统中完全卸载 Bito CLI。

Mac 用户请注意： 您可能会遇到与验证相关的问题，为此您需要手动按照此处的步骤操作：Apple 支持页面（我们正在尽快解决此问题）。

Windows

1. 通过 MSI 安装程序安装 Bito CLI，安装程序链接如下：installer。
2. 在 Windows 11 上，您可能会收到有关发布者验证的通知。请点击“显示更多”或“更多信息”，然后点击“仍要运行”（我们正在尽快解决这个问题）。
3. 安装完成后，打开一个新的命令提示符并运行 bito 即可开始使用。

卸载 Bito CLI

MAC 和 Linux

sudo curl https://alpha.bito.ai/downloads/cli/uninstall.sh -fsSL | bash （这将彻底卸载 Bito CLI 及其所有组件）

Windows

对于 Windows 用户，您可以像卸载其他软件一样，通过控制面板卸载 Bito CLI。您仍然可以参考此处提供的链接：卸载 Bito CLI。

手动下载二进制文件安装（不推荐）

虽然不推荐，但您也可以从我们的仓库下载 Bito CLI 的二进制文件，并手动安装。该二进制文件适用于 Linux 和 Mac OS，支持 x86 和 ARM 架构。

Mac & Linux

1. 从 这里 下载适合您操作系统平台的 Bito CLI 二进制文件（请下载最新版本以获取所有更新）。
2. 打开终端，进入您下载二进制文件的目录，将下载的文件（在下面的命令中使用您下载的 bito-* 文件名）重命名为 bito： mv bito-<os>-<arch> bito
3. 使用以下命令使文件可执行： chmod +x ./bito
4. 使用以下命令将二进制文件复制到 /usr/local/bin： sudo cp ./bito /usr/local/bin
5. 设置 PATH 环境变量，以便始终可以访问 Bito CLI： PATH=$PATH:/usr/local/bin
6. 使用 bito 命令运行 Bito CLI。如果未设置 PATH 环境变量，您需要使用完整路径或相对路径来运行 Bito 可执行文件。

Windows

1. 使用 Bito CLI 时，务必先切换到包含 Bito CLI 的目录再运行它。
2. 设置 PATH 环境变量，以便始终可以访问 Bito CLI：
   • 请按照此链接中的说明操作：设置 PATH 变量
   • 编辑“Path”变量，添加 Bito CLI 在您计算机上安装位置的新路径。

Bito CLI 命令

help

• 在 MAC/Linux 上： 运行 bito --help 或 bito config --help

• 在 Windows 上： 运行 bito --help 或 bito config --help

斜杠命令

Bito CLI 引入了斜杠命令，旨在通过 CLI 提供“理解您代码的 AI”等功能。借助此功能，您可以访问由 IDE 中的 Bito 扩展创建的代码索引。斜杠命令可用于快速执行诸如查看所有本地代码索引、选择特定本地代码索引以及对该索引进行 LCA 查询等操作。

• 在 Bito CLI 交互模式的 bito> 提示符中输入 "/" 并按 ENTER 或 TAB 键，即可查看所有可用命令。
• 在 Bito CLI 交互模式的 bito> 提示符中输入 "/[command_name]" 并按 ENTER 或 TAB 键，即可查看该命令的所有可用选项。
• 在 Bito CLI 交互模式的 bito> 提示符中输入 "/[command_name] [option_name]" 并按 ENTER 或 TAB 键，即可执行相应的选项。
• 运行 bito --help 以获取与斜杠命令相关的帮助。

Bito CLI MyPrompt（使用 Bito CLI 自动化）

在 MAC/Linux 上：

• 运行 bito -v 或 bito --version 以打印当前安装的 Bito CLI 版本号。

• 运行 bito –p writedocprompt.txt -f mycode.js 以在 Bito 中启用非交互模式（其中 writedocprompt.txt 将包含您的提示文本，例如“简要解释以下代码”，而 mycode.js 则包含需要执行操作的实际代码）。

• 运行 bito –p writedocprompt.txt 以从标准输入读取内容并传递给 Bito（其中 writedocprompt.txt 将包含您的提示文本，例如“简要解释以下代码”，而输入内容则为需要执行操作的实际代码）。

• 运行 cat file.txt | bito 直接将文件内容输出并通过管道传递给 Bito，从而立即获得查询结果。

• 运行 cat inventory.sql | bito -p testdataprompt.txt > testdata.sql 将输出直接重定向到文件（其中 -p 可与 cat 结合使用，对给定内容执行提示相关操作）。

• 运行 cat inventory.sql | bito -c runcontext.txt -p testdataprompt.txt > testdata.sql 将上下文/对话历史存储在非交互模式下的文件 runcontext.txt 中，以便在需要先前上下文时用于后续命令。如果 runcontext.txt 不存在，则会自动创建。请提供新文件或使用 -c 选项由 Bito 创建的现有上下文文件。现在通过 -c 选项，非交互模式下也支持上下文

• 运行 echo "给我一段 Python 的冒泡排序代码" | bito 即可使用 Bito CLI 立即获得查询响应。

在 Windows 上：

• 运行 bito -v 或 bito --version 以打印当前安装的 Bito CLI 版本号。

• 运行 bito –p writedocprompt.txt -f mycode.js 以在 Bito 中启用非交互模式（其中 writedocprompt.txt 将包含您的提示文本，例如“简要解释以下代码”，而 mycode.js 则包含需要执行操作的实际代码）。

• 运行 bito –p writedocprompt.txt 以从标准输入读取内容并传递给 Bito（其中 writedocprompt.txt 将包含您的提示文本，例如“简要解释以下代码”，而输入内容则为需要执行操作的实际代码）。

• 运行 type file.txt | bito 从 Windows 文件中获取输入，并将其通过管道传递给 Bito，从而立即获得查询结果。

• 运行 type inventory.sql | bito -p testdataprompt.txt > testdata.sql 将输出直接重定向到文件（其中 -p 可与 type 结合使用，对给定内容执行提示相关操作）。

• 运行 type inventory.sql | bito -c runcontext.txt -p testdataprompt.txt > testdata.sql 将上下文/对话历史存储在非交互模式下的文件 runcontext.txt 中，以便在需要先前上下文时用于后续命令。如果 runcontext.txt 不存在，则会自动创建。请提供新文件或使用 -c 选项由 Bito 创建的现有上下文文件。现在通过 -c 选项，非交互模式下也支持上下文

• 运行 echo "给我一段 Python 的冒泡排序代码" | bito 即可使用 Bito CLI 立即获得查询响应。

关于 Bito CLI MyPrompt 的更多说明：

使用注释：

在您的提示文件中，任何位于 # 之后的内容都将被 Bito CLI 视为注释，不会成为提示的一部分。

您可以使用 \# 作为转义序列，使 # 成为您提示的一部分，而不用于注释。

以上几点的几个示例：

1. 给我一个 Python 中的冒泡排序示例 # 此处写的一切都将被视为注释。
2. 解释这段代码的作用：\#include<stdio.h>
   i. 在上面的例子中，\# 可以用作转义序列，将 # 包含在您的提示中。
3. #这将被视为注释，因为它本身就以 # 开头。

禁用注释：

若希望将 # 视为普通字符而非用于标记注释开头的特殊字符（这是默认行为），可以在 Bito CLI 命令中使用 -i/--ignore 标志。
使用 -i/--ignore 标志后，Bito CLI 将不再将 # 视为特殊符号，而是将其作为提示的一部分进行处理。

例如：“bito -p prompt.txt -i” 将确保即使您的提示文件中存在 # 符号，它也不会被视为注释，您的文件将按原样被处理。

使用宏：

在提示文件中使用 {{%input%}} 宏来引用通过 -f 选项提供的文件内容。

示例：要检查某个文件是否包含 JS 代码，您可以创建一个名为 checkifjscode.txt 的提示文件，内容如下：

上下文如下，位于 contextstart 和 contextend 之间
contextstart
{{%input%}}
contextend
请检查上下文中提供的内容是否为 JS 代码。

示例：

以下是两个示例，展示 My Prompt 的实际应用：

1. 如何使用 Bito CLI My Prompt 轻松创建 Git 提交信息和 Markdown 文档：

2. 如何使用 Bito CLI My Prompt 生成测试数据：

Bito CLI 配置

bito config [flags]

• 运行 bito config -l 或 bito config --list 以列出所有配置变量及其值。

• 运行 bito config -e 或 bito config --edit 以在默认编辑器中打开配置文件。

示例配置

bito:
 access_key: ""
 email: first.last@mycompany.com
 preferred_ai_model: ADVANCED
settings:
 auto_update: true
 max_context_entries: 20

首选 AI 模型类型

默认情况下，AI 模型类型设置为 ADVANCED，可以通过运行 bito -m <BASIC/ADVANCED> 来覆盖此设置。 模型类型用于当前会话中的 AI 查询。模型类型可以设置为 BASIC 或 ADVANCED，不区分大小写。

“ADVANCED”指的是像 GPT-4o、Claude Sonnet 3.5 等顶级 AI 模型；而“BASIC”则指 GPT-4o mini 等类似模型。

使用 BASIC AI 模型时，您的提示和聊天记忆将被限制在 40,000 个字符（约 18 页单倍行距文本）。然而，使用 ADVANCED AI 模型时，提示和聊天记忆可扩展至 240,000 个字符（约 110 页单倍行距文本）。这意味着 ADVANCED 模型能够处理您的整个代码文件，从而提供更准确的答案。

如果您希望在复杂任务中获得最佳结果，请选择 ADVANCED AI 模型。

Bito CLI 还会在标准错误输出中打印已配置的模型以及当前会话正在使用的模型，供您参考。如果您运行 bito，您应该会看到“Model configured”显示为 “BASIC/ADVANCED”。这正是您 CLI 配置中所设置的模型（可通过 bito config -e 访问）。

当您开始进行查询时，根据您的 Bito 账单计划：如果您处于免费计划，则模型将自动切换为 BASIC，并且您会看到“Model in use:”显示为 BASIC。

如果您是付费计划用户且尚未用尽高级查询额度，则会看到“Model in use:”显示为 ADVANCED。

访问密钥

访问密钥可以在 Bito Web UI 上创建，并在 Bito CLI 中使用。

创建访问密钥的步骤如下：

• 登录您的账户：https://alpha.bito.ai
• 登录后，打开：https://alpha.bito.ai/home/settings/advanced
• 在“Bito Access Key”部分点击“Create new key”按钮以创建新密钥并复制它。
• 请务必妥善保管您的密钥，切勿将其提交到任何代码库中，以免意外泄露。
• 如果您怀疑密钥已被泄露，可以随时删除现有密钥并重新创建新的密钥。

访问密钥是电子邮件和 OTP 验证之外的另一种身份验证机制。

访问密钥可以通过运行 bito config -e 持久化到 Bito CLI 中。 这种持久化的访问密钥可以通过运行 bito -k <access-key> 或 bito --key <access-key> 在临时会话中被覆盖。

输出语言

默认情况下，Bito CLI 以英语生成输出。您可以从这里将输出语言更改为首选语言。

目前，当 CLI 处于运行状态时，语言更改需要 30 分钟才能生效。若要立即生效，您可以使用 Ctrl+C 退出当前 CLI 会话，然后再次运行 bito。

常见问题解答

在 Windows 10 及以下版本中启用 Unicode：

1. 如果您使用的是 Windows 10 或更低版本，命令提示符可能无法直接支持 Unicode 字符（使用其他语言）。您可以在使用 bito 之前，在 cmd 中运行命令 chcp 936，以在 Windows 10 及以下版本中支持 Unicode 字符。（如需撤销此处所做的设置，您可以参考此链接)。
2. 如果您使用的是 Windows 11，则不应遇到此类问题。

许可证

版权所有 © 2021，Bito Inc - 版权所有

Bito CLI 快速上手指南

Bito CLI 是一个命令行工具，让您在终端中直接使用 Bito AI 的聊天功能，支持代码解释、生成及自动化工作流。

环境准备

在使用前，请确保您的系统满足以下基本要求：

• 操作系统：macOS、Linux 或 Windows。
• 终端环境：
  • macOS / Linux：Bash 或其他兼容 Shell。
  • Windows：CMD 或 PowerShell。
• 网络要求：需要能够访问 alpha.bito.ai 或 GitHub 资源（若下载受阻，建议配置网络代理）。

安装步骤

根据您的操作系统选择推荐的安装方式：

macOS 和 Linux

方式一：一键脚本安装（推荐） 此方法会自动下载并安装最新版本。

sudo curl https://alpha.bito.ai/downloads/cli/install.sh -fsSL | bash

方式二：使用 Homebrew (macOS)

# 1. 添加仓库源
brew tap gitbito/bitocli

# 2. 安装 Bito CLI
brew install bito-cli

# 后续更新命令
brew update && brew upgrade bito-cli

方式三：Arch Linux

yay -S bito-cli
# 或者
paru -S bito-cli

注意：macOS 用户若在运行时遇到“无法验证开发者”的提示，需前往系统设置中手动允许该应用运行。

Windows

1. 下载官方提供的 MSI 安装包：Bito CLI Installer
2. 运行安装程序。
   • Windows 11 用户：若出现"SmartScreen 筛选器”警告，点击“更多信息”，然后选择“仍要运行”。
3. 安装完成后，打开新的命令提示符（CMD）窗口即可使用。

基本使用

安装完成后，您可以通过以下方式开始使用：

1. 启动交互式对话

在终端输入以下命令启动 Bito CLI：

bito

进入交互模式后（提示符为 bito>），您可以直接输入自然语言问题，例如：

awk command to print first and last column

操作提示：

• 多行输入：按 Enter 键换行。
• 提交请求：输入完成后，按 Ctrl+D 发送提示词。
• 退出程序：输入 quit 后按 Ctrl+D，或直接按 Ctrl+C 终止。

2. 非交互式命令（管道与自动化）

您可以将文件内容通过管道传递给 Bito，或直接指定文件进行处理，非常适合脚本自动化。

示例 A：直接查询

echo "give me code for bubble sort in python" | bito

示例 B：处理文件内容 (Linux/macOS) 读取 file.txt 内容并询问：

cat file.txt | bito

示例 C：处理文件内容 (Windows)

type file.txt | bito

示例 D：结合提示词文件与代码文件 假设 writedocprompt.txt 包含提示词（如“简要解释以下代码”），mycode.js 是目标代码：

bito -p writedocprompt.txt -f mycode.js

示例 E：保存上下文历史 使用 -c 参数在非交互模式下保存对话上下文，以便后续命令延续话题：

cat inventory.sql | bito -c runcontext.txt -p testdataprompt.txt > testdata.sql

3. 高级功能简述

• 斜杠命令 (/)：在交互模式下输入 / 并回车，可查看可用命令列表（如管理本地代码索引）。
• 宏变量：在提示词文件中使用 {{%input%}} 引用通过 -f 传入的文件内容。
• 注释支持：提示词文件中以 # 开头的行被视为注释。若需使用 # 字符，请使用 \# 转义或添加 -i 标志忽略注释规则。

更多详细配置可使用 bito --help 或 bito config --help 查看。