🗄️ 项目已归档（不再维护）

Chatblade 现已归档，不再进行积极开发。它在大语言模型工具的早期阶段发挥了作用，但如今直接使用 Claude Code 或 Codex 通常会更好。

如果你正在寻找类似精神的现代 CLI 工具，我推荐 llm (https://github.com/simonw/llm) 或 Fabric (https://github.com/danielmiessler/Fabric)。

Chatblade

一个用于 ChatGPT 的命令行瑞士军刀

Chatblade 是一款多功能的命令行界面（CLI）工具，旨在与 OpenAI 的 ChatGPT 进行交互。它可以接受管道输入、参数或两者结合，并允许你保存常用的提示前言以便快速使用。此外，Chatblade 还提供了从 ChatGPT 响应中提取 JSON 或 Markdown 的实用方法。

注意：你需要设置 OpenAI API 密钥才能使用 Chatblade。

你可以通过传递 --openai-api-key KEY 或设置环境变量 OPENAI_API_KEY 来完成此操作（推荐）。以下示例均假设已设置了环境变量。

安装

最新版本

要保持与当前主分支同步，你可以：

• 克隆项目并运行 pip install .
• 或者使用 pip install 'chatblade @ git+https://github.com/npiv/chatblade'

通过 PyPI

最新发布的版本可以通过 pip install chatblade --upgrade 安装。

通过 Brew

brew install chatblade

文档

发起查询

新的对话

你可以直接输入内容开始任何查询。例如：

chatblade 如何用 ffmpeg 从视频的 22 分 01 秒处提取静帧？

调用上次对话

如果你想调用上次对话，只需使用 -l 参数：

chatblade -l

继续上次对话

若想继续对话并在上下文中提出修改，可以再次使用 -l 并附加查询：

chatblade -l 我们能否从 00:22:01 到 00:22:04 制作一个 GIF？

-l 是 -S last 或“最后会话”的简写。我们还可以使用会话选项来跟踪和继续多个不同的对话。

在 gpt-3.5 和 4 之间切换

默认使用 gpt-3.5，你可以在任何时候通过 -c 4 切换到 4 版本，或者使用 -c 4o 切换到最新的 4o（“omni”）。此外，你也可以传递任意完整的模型名称，例如 -c gpt-3.5-turbo-16k。

交互式聊天

如果你更喜欢交互式聊天，只需使用 chatblade -i。

显示流式文本（实验性）

你还可以像 Web UI 一样流式显示响应。流式结束后，结果会被格式化。这可以在交互式会话中结合使用：

chatblade -s -i

https://user-images.githubusercontent.com/452020/226891636-54d12df2-528f-4365-a4f3-e51cb025773c.mov

格式化结果

Chatblade 会解析响应，如果它认为是 Markdown 格式，就会以 Markdown 的方式呈现，从而实现语法高亮。但有时这可能不是你想要的，因为它会移除换行符，或者你只是想提取部分结果并将其传递给另一个命令。

在这种情况下，你有两种选择：

• -r 表示“原始”，它会原样打印 ChatGPT 返回的文本，而不经过 Markdown 处理。
• -e 表示“提取”，它会尝试检测返回的内容（代码块或 JSON），并仅提取该部分。如果未找到这两者，则行为与 -r 相同。

这两种选项都可以与新的查询一起使用，例如：

chatblade -e 写一个启动服务器并打印“Hello World”的 Python 模板脚本 > main.py

或者与上次的结果结合使用（本例中为 JSON）：

chatblade -l -e | jq

将内容通过管道传入 Chatblade

如果我们有较长的提示，不想每次都手动输入，或者只是想为查询提供上下文，就可以通过管道将内容传入 Chatblade。

例如：

curl https://news.ycombinator.com/rss | chatblade 根据以上 RSS，请告诉我关于 AI 的前三篇文章及其链接 -c 4

管道输入会放在查询之前，然后发送给 ChatGPT。

或者：

chatblade 这个脚本是做什么的？ < script.sh

实际发送给 ChatGPT 的内容是：

管道输入
-------
查询

会话选项

会话是指命名的对话。

如果你使用自定义会话名 SESS 启动 Chatblade：

chatblade -S SESS 我们能否从 00:22:01 到 00:22:04 制作一个 GIF？

Chatblade 会创建名为 SESS 的会话（如果它不存在），并将当前的查询-响应对存储在该会话中。

如果该会话已经存在，系统会加载已保存的对话，并将新的交互追加到其中。

如果没有指定会话参数，交互也会被存储在名为 last 的会话中；然而，后续无会话调用会覆盖 last 的内容。你可以通过传递 -S last 继续一个以无会话方式开始的对话，但 last 并不是一个安全的地方来保存对话，因为下一次无会话调用会再次清空它。-l 选项是 -S last 的简写。

如果你只指定会话而没有查询：

chatblade -S SESS

Chatblade 会调用该会话，但不会修改会话内容。

Chatblade 支持多种会话操作。它提供了 --session-OP 选项，其中 OP 可以是 list、path、dump、delete 或 rename。

检查 token 数量和预估费用

如果你想检查上一次查询的大致成本和 token 使用情况，可以使用 -t 标志，表示“token”。

例如，在上面的例子中，当我们传递大量上下文时，就可以这样做：

curl https://news.ycombinator.com/rss | chatblade 根据以上 RSS，请告诉我关于 AI 的前三篇文章及其链接 -t

此操作不会在网络上执行任何操作，而只是在本地计算 token 数量。

使用自定义提示（系统消息）

系统消息用于指示模型的行为方式，详情请参阅 OpenAI - 指导聊天模型。

这些提示可以通过 -p 参数加载。为方便起见，我们将任何放置在 ~/.config/chatblade/ 目录下的文件都交由该命令自动读取。

例如，假设我们有一个名为 ~/.config/chatblade/etymology 的文件，内容如下：

我希望你扮演一位专业的词源学家兼测验生成器。你对词源学有深入的了解，并会收到一个单词作为输入。
目标是创建一系列卡片，既测试词源知识，也通过释义来猜测单词。

以下是一个针对单词“disparage”的完美答案示例：

[{
  "question": "一个动词，用来表示以消极或贬低的方式谈论某人或某事。<br/> <i>例如：他经常在背后 _______ 他的同事。</i>",
  "answer": "disparage"
},
{
  "question": "单词 disparage 的词源是什么？",
  "answer": "源自古法语单词 <i>'desparagier'</i>, 意为‘与地位不平等的人结婚’，由 <i>'des-'</i>（意为‘否定’）和 <i>'parage'</i>（意为‘平等地位’）组成"
}]

你只需以 JSON 格式返回答案。如实作答；若不确定，请明确说明。问题应尽可能贴近提供的示例。务必在释义题中包含一个例句。使用 HTML 格式化字符串，使答案更加美观。

如果提供了多个单词，则需为每个单词分别创建问题和答案，并将它们汇总成一个列表。

仅以 JSON 格式作答，不得添加其他文本。有效的 JSON 必须使用双引号 `""` 包裹其键值。

现在我们可以运行一条命令，并通过 -p etymology 引用此提示：

chatblade -p etymology gregarious

此外，您也可以直接指定文件路径来加载任意位置的系统消息：

由于我们要求输出为 JSON 格式，因此可以将其管道传递给其他工具，例如：

chatblade -l -e > toanki

配置 Azure OpenAI

chatblade 可以与 Azure OpenAI 终端点一起使用。在这种情况下，除了设置 OPENAI_API_KEY 环境变量外，还需要配置以下环境变量：

• OPENAI_API_TYPE :: 设置为 azure。这是 openai-python 库的要求。
• AZURE_OPENAI_ENDPOINT :: 您的认知服务终端点 URL，例如 https://eastus.api.cognitive.microsoft.com/。请注意，这是 openai-python 引入的一项重大变更，之前的环境变量名称为 OPENAI_API_BASE。
• OPENAI_API_AZURE_ENGINE :: 您在 Azure 中的部署名称，例如 my-gpt-35-turbo（对应特定模型）。

注意：这将覆盖任何 -c 3.5 或 -c 4 选项，因为在这种情况下这些选项不再适用。

帮助信息

用法: Chatblade [-h] [--openai-api-key key] [--openai-base-url key] [--temperature t] [-c CHAT_GPT] [-i] [-s] [-t] [--version] [-p name] [-e] [-r] [-n] [-o] [--theme theme] [-l]
                 [-S sess] [--session-list] [--session-path] [--session-dump] [--session-delete] [--session-rename newsess]
                 [query ...]

一款适用于 ChatGPT 的多功能 CLI 工具

位置参数:
  query                            发送给 ChatGPT 的查询内容

可选参数:
  -h, --help                       显示帮助信息并退出
  --openai-api-key key             OpenAI API 密钥也可通过环境变量 OPENAI_API_KEY 设置
  --openai-base-url key            自定义 URL，用于对接本地或自定义模型，例如 Ollama
  --temperature t                  温度参数（OpenAI 设置）
  -c CHAT_GPT, --chat-gpt CHAT_GPT
                                   指定 ChatGPT 模型，可使用完整模型名称，或简写形式：3.5（gpt-3.5-turbo）、4（gpt-4）、4t（gpt-4-turbo）、4o（gpt-4o）、mini（gpt-4o-mini）、o1（o1-preview）、o1mini（o1-mini）。也可通过环境变量 OPENAI_API_MODEL 设置
  -i, --interactive                启动交互式聊天会话。此模式会自动延续对话
  -s, --stream                     将接收到的文本流式输出到终端
  -t, --tokens                     显示即将发送的内容、令牌数量及预估费用
  --version                        显示 chatblade 版本
  -p name, --prompt-file name      提示文件名——将从 ~/.config/chatblade/name 或指定路径加载相应提示

结果格式化选项:
  -e, --extract                    如果可能，从响应中提取内容（JSON 或代码块）
  -r, --raw                        以纯文本形式打印会话，不进行美化或格式化
  -n, --no-format                  不对输出添加美化格式
  -o, --only                       仅显示响应内容，省略查询部分
  --theme theme                    设置语法高亮主题，详见 https://pygments.org/styles/；也可通过 CHATBLADE_THEME 环境变量设置

会话选项:
  -l, --last                       “-S last”的别名，即未指定会话时的默认会话
  -S sess, --session sess          启动或继续命名会话
  --session-list                   列出所有会话
  --session-path                   显示会话文件的存储路径
  --session-dump                   将会话内容转储到标准输出
  --session-delete                 删除会话
  --session-rename newsess         重命名会话

Chatblade 快速上手指南

⚠️ 重要提示：本项目已归档（Archived），不再维护。作者建议现代场景下直接使用 Claude Code、Codex，或尝试替代工具 llm (Simon Willison) 和 Fabric (Daniel Miessler)。以下指南仅供参考或维护旧项目使用。

Chatblade 是一个用于与 OpenAI ChatGPT 交互的命令行工具（CLI）。它支持管道输入、参数传递、会话管理以及从响应中提取 JSON/代码块等功能。

环境准备

• 操作系统：Linux, macOS, Windows (需配置 Python 环境)
• 前置依赖：
  • Python 3.7+
  • pip 包管理工具
• API 密钥：
  • 需要拥有 OpenAI API Key。
  • 推荐将密钥设置为环境变量，避免每次命令都输入：

    export OPENAI_API_KEY="你的 sk-xxxxxx 密钥"
    

  • 注：国内用户若使用代理或中转服务，可能还需设置 OPENAI_BASE_URL。

安装步骤

你可以选择以下任意一种方式进行安装：

方式一：通过 PyPI 安装（推荐）

pip install chatblade --upgrade

国内用户可使用清华源加速：

pip install chatblade --upgrade -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：通过 Homebrew 安装 (macOS/Linux)

brew install chatblade

方式三：安装最新开发版

pip install 'chatblade @ git+https://github.com/npiv/chatblade'

基本使用

1. 发起单次查询

直接在命令后跟随问题即可，默认使用 gpt-3.5-turbo 模型。

chatblade 如何用 ffmpeg 在 22:01 处提取视频帧？

2. 切换模型

使用 -c 参数指定模型，支持 3.5, 4, 4o, 4t, mini 等简写或完整模型名。

# 使用 GPT-4
chatblade -c 4 请解释量子纠缠

# 使用特定版本
chatblade -c gpt-4-turbo-preview 写一个 Python 脚本

3. 多轮对话与会话管理

• 继续上一次对话：使用 -l 参数。

  chatblade -l 把上面的代码改成异步版本
  

• 命名会话：使用 -S 创建或切换到指定会话。

  # 创建名为 "project_a" 的会话
  chatblade -S project_a 初始化一个 React 项目结构
  
  # 后续在该会话中继续提问
  chatblade -S project_a 添加路由配置
  

4. 管道输入 (Piping)

可以将其他命令的输出作为上下文传递给 Chatblade。

# 分析日志文件
cat error.log | chatblade 分析上述日志中的主要错误原因

# 结合网络请求
curl https://example.com/data.json | chatblade -c 4 总结这份 JSON 数据的核心字段

5. 结果提取与格式化

• 提取代码或 JSON：使用 -e 自动识别并提取代码块或 JSON 内容，方便重定向到文件。

  # 生成脚本并直接保存为 main.py
  chatblade -e 写一个打印 Hello World 的 Python 脚本 > main.py
  
  # 提取上次回答的 JSON 并用 jq 处理
  chatblade -l -e | jq
  

• 原始输出：使用 -r 禁止 Markdown 格式化，保留原始换行。

  chatblade -r 输出一段纯文本列表
  

6. 交互式模式

启动类似终端的交互聊天界面：

chatblade -i

若需流式输出（打字机效果）：

chatblade -s -i

7. 自定义系统提示词 (Prompts)

将常用的 System Prompt 保存在 ~/.config/chatblade/ 目录下，通过 -p 调用。

1. 创建文件 ~/.config/chatblade/translator：

   You are a professional translator. Translate the following text into Chinese strictly.
   

2. 使用：

   chatblade -p translator Hello world
   

8. 查看 Token 消耗预估

在实际发送请求前，使用 -t 计算 Token 数量和预估成本（本地计算，不消耗额度）：

chatblade -t 这是一段很长的背景资料... 请总结