gpt-cli

用于聊天型大语言模型的命令行界面。

立即试用

export ANTHROPIC_API_KEY=xcxc
uvx --from gpt-command-line gpt

支持的提供商

• OpenAI
• Anthropic
• Google Gemini
• Cohere
• 其他兼容 OpenAI 的 API（例如 Together、OpenRouter，以及使用 LM Studio 的本地模型）

功能特性

• 命令行界面：直接在终端中与 ChatGPT 或 Claude 交互。
• 模型自定义：为每个助手覆盖默认的模型、温度和 top_p 值，从而对 AI 的行为进行精细控制。
• 扩展思考模式：启用 Claude 3.7 的扩展思考功能，以查看其在复杂问题上的推理过程。
• 用量跟踪：通过统计 token 数量和价格信息来跟踪 API 使用情况。
• 快捷键：使用 Ctrl-C、Ctrl-D 和 Ctrl-R 快捷键，更方便地管理对话和输入。
• 多行输入：进入多行模式，以处理更复杂的查询或对话。
• Markdown 支持：可选择开启或关闭聊天会话中的 Markdown 格式，以便根据个人偏好调整输出。
• 预设消息：为自定义助手设置预设消息，以建立上下文或角色扮演场景。
• 多助手支持：轻松在不同助手之间切换，包括通用助手、开发助手以及在配置文件中定义的自定义助手。
• 灵活配置：可在 YAML 配置文件中定义助手、模型参数和 API 密钥，便于自定义和管理。

安装

此安装假定您有一台已安装 Python 和 pip 的 Linux/OSX 机器。

pip install gpt-command-line

从源代码安装最新版本：

pip install git+https://github.com/kharvd/gpt-cli.git

或者手动克隆仓库进行安装：

git clone https://github.com/kharvd/gpt-cli.git
cd gpt-cli
pip install .

将 OpenAI API 密钥添加到您的 .bashrc 文件中（位于主目录下）。在此示例中我们使用 nano 编辑器，您也可以使用任何其他文本编辑器。

nano ~/.bashrc
export OPENAI_API_KEY=<your_key_here>

运行工具：

gpt

您还可以使用 gpt.yml 文件进行配置。请参阅下方的 配置 部分。

使用方法

请确保将 OPENAI_API_KEY 环境变量设置为您自己的 OpenAI API 密钥（或将其放入 ~/.config/gpt-cli/gpt.yml 文件中，如下所述）。

用法: gpt [-h] [--no_markdown] [--model MODEL] [--temperature TEMPERATURE] [--top_p TOP_P]
              [--thinking THINKING_BUDGET] [--log_file LOG_FILE] 
              [--log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--prompt PROMPT] 
              [--execute EXECUTE] [--no_stream] [{dev,general,bash}]

运行与 ChatGPT 的聊天会话。更多信息请访问 https://github.com/kharvd/gpt-cli。

位置参数:
  {dev,general,bash}
                        要使用的助手名称。`general`（默认）是一个通用的帮助助手，`dev` 是一个软件开发助手，回复较短。您可以在配置文件 ~/.config/gpt-cli/gpt.yml 中指定自己的助手。更多信息请参阅 README。

可选参数:
  -h, --help            显示此帮助信息并退出
  --no_markdown         禁用聊天会话中的 Markdown 格式。
  --model MODEL         用于聊天会话的模型。覆盖助手定义的默认模型。
  --temperature TEMPERATURE
                        用于聊天会话的温度。覆盖助手定义的默认温度。
  --top_p TOP_P         用于聊天会话的 top_p 值。覆盖助手定义的默认 top_p。
  --thinking THINKING_BUDGET
                        启用 Claude 的扩展思考模式，并指定 token 预算。仅适用于 Claude 3.7 模型。
  --log_file LOG_FILE   日志写入文件。支持 strftime 格式代码。
  --log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        日志级别
  --prompt PROMPT, -p PROMPT
                        如果指定，则不会启动交互式聊天会话，而是将响应打印到标准输出并退出。可以多次指定。使用 `-` 可从标准输入读取提示。隐含 --no_markdown。
  --execute EXECUTE, -e EXECUTE
                        如果指定，会将提示传递给助手，并允许用户在执行之前编辑生成的 shell 命令。隐含 --no_stream。使用 `-` 可从标准输入读取提示。
  --no_stream           如果指定，将不会将响应流式传输到标准输出。这在需要将响应用于脚本时很有用。当未指定 --prompt 选项时，此选项将被忽略。
  --no_price            禁用价格记录。

输入 :q 或 Ctrl-D 退出，:c 或 Ctrl-C 清除对话，:r 或 Ctrl-R 重新生成上一条回复。要进入多行模式，输入反斜杠 \ 后换行。按 ESC 键后再按 Enter 键即可退出多行模式。

dev 助手被设定为软件开发专家，并提供简短的回复。

$ gpt dev

bash 助手被设定为 Bash 脚本专家，只提供 Bash 命令。使用 --execute 选项可以执行这些命令。它最适合与 gpt-4 模型配合使用。

gpt bash -e "How do I list files in a directory?"

这将提示您在执行前使用 $EDITOR 编辑该命令。

配置

您可以在配置文件 ~/.config/gpt-cli/gpt.yml 中配置助手。该文件是一个 YAML 文件，具有以下结构（另请参阅 config.py）：

default_assistant: <assistant_name>
markdown: False
openai_api_key: <openai_api_key>
anthropic_api_key: <anthropic_api_key>
log_file: <path>
log_level: <DEBUG|INFO|WARNING|ERROR|CRITICAL>
assistants:
  <assistant_name>:
    model: <model_name>
    temperature: <temperature>
    top_p: <top_p>
    thinking_budget: <token_budget>  # 仅限 Claude 3.7 模型
    messages:
      - { role: <role>, content: <message> }
      - ...
  <assistant_name>:
    ...

您也可以覆盖预定义助手的参数。

可以通过设置 default_assistant 字段来指定默认使用的助手。如果您未指定，则默认助手为 general。您还可以为助手指定要使用的 model、temperature 和 top_p。如果未指定，则使用默认值。这些参数也可以通过命令行参数进行覆盖。

示例：

default_assistant: dev
markdown: True
openai_api_key: <openai_api_key>
assistants:
  pirate:
    model: gpt-4
    temperature: 1.0
    messages:
      - { role: system, content: "你是一名海盗。" }

$ gpt pirate

> Arrrr
你好啊，伙计！是什么风把你吹到这片海域来了？无论你是来寻宝还是冒险，我们都可以一起扬帆远航。准备好你的地图和罗盘吧，因为我们的旅程还很长呢！

使用 !include 将其他上下文读入助手

您可以使用 !include <file_path> 将文件内容读入助手的上下文中。

default_assistant: dev
markdown: True
openai_api_key: <openai_api_key>
assistants:
  pirate:
    model: gpt-4
    temperature: 1.0
    messages:
      - { role: system, content: !include "pirate.txt" }

自定义 OpenAI API URL

如果您使用的是与 OpenAI Python SDK 兼容的其他模型，可以通过修改配置文件中的 openai_base_url 设置或使用 OPENAI_BASE_URL 环境变量来进行配置。

示例：

openai_base_url: https://your-custom-api-url.com/v1

对于非 GPT 模型名称，可以在模型名称前加上 oai-compat: 前缀，以将其传递给 API。例如，要在 Together 上与 Llama3-70b 对话，可以使用以下命令：

OPENAI_API_KEY=$TOGETHER_API_KEY OPENAI_BASE_URL=https://api.together.xyz/v1 gpt general --model oai-compat:meta-llama/Llama-3-70b-chat-hf

在将请求发送到 API 之前，会先去掉该前缀。

同样，使用 oai-azure: 模型名称前缀可以使用通过 Azure Open AI 部署的模型。例如，oai-azure:my-deployment-name。

借助助手配置，您可以为特定助手覆盖基础 URL 和 API 密钥。

# ~/.config/gpt-cli/gpt.yml
assistants:
  llama:
    model: oai-compat:meta-llama/llama-3.3-70b-instruct
    openai_base_url_override: https://openrouter.ai/api/v1
    openai_api_key_override: $OPENROUTER_API_KEY

其他聊天机器人

Anthropic Claude

要使用 Claude，您需要从 Anthropic 获取 API 密钥（目前 API 访问仍处于等待名单中）。获取 API 密钥后，您可以添加一个环境变量

export ANTHROPIC_API_KEY=<your_key_here>

或者在 ~/.config/gpt-cli/gpt.yml 中添加一行配置：

anthropic_api_key: <your_key_here>

现在您应该可以使用 --model claude-3-(opus|sonnet|haiku)-<date> 运行 gpt 命令了。

gpt --model claude-3-opus-20240229

Claude 3.7 Sonnet 扩展思考模式

Claude 3.7 Sonnet 支持扩展思考模式，该模式会在给出最终答案之前展示 Claude 的推理过程。这对于复杂分析、高级 STEM 问题以及具有多重约束的任务非常有用。

通过 --thinking 参数启用该模式，并指定用于思考过程的 token 预算：

gpt --model claude-3-7-sonnet-20250219 --thinking 32000

您也可以在配置中为特定助手配置思考模式：

assistants:
  math:
    model: claude-3-7-sonnet-20250219
    thinking_budget: 32000
    messages:
      - { role: system, content: "你是一位数学专家。" }

注意：当启用思考模式时，温度会自动设置为 1.0，而 top_p 则会被取消设置，这是 Claude API 的要求。

Google Gemini

export GOOGLE_API_KEY=<your_key_here>

或者

google_api_key: <your_key_here>

Cohere

export COHERE_API_KEY=<your_key_here>

或者

cohere_api_key: <your_key_here>

gpt-cli 快速上手指南

gpt-cli 是一个功能强大的命令行工具，允许你在终端中直接与 ChatGPT、Claude、Gemini 等大语言模型进行交互。它支持多助手配置、流式输出、代码执行及详细的 Token 用量统计。

环境准备

• 操作系统：Linux 或 macOS
• 依赖环境：Python 3 及 pip 包管理工具
• API 密钥：需提前准备好对应服务商的 API Key（如 OpenAI、Anthropic、Google Gemini 等）

安装步骤

方式一：使用 pip 安装（推荐）

pip install gpt-command-line

如需安装最新开发版本：

pip install git+https://github.com/kharvd/gpt-cli.git

方式二：源码安装

git clone https://github.com/kharvd/gpt-cli.git
cd gpt-cli
pip install .

配置 API 密钥

将 API 密钥添加到环境变量中（以 OpenAI 为例），编辑 ~/.bashrc 或 ~/.zshrc：

nano ~/.bashrc

添加以下内容：

export OPENAI_API_KEY=<your_key_here>

保存后生效：

source ~/.bashrc

提示：你也可以在配置文件 ~/.config/gpt-cli/gpt.yml 中直接设置 openai_api_key 字段，无需设置环境变量。

基本使用

启动交互式对话

运行以下命令即可开始与默认助手（general）对话：

gpt

常用快捷键：

• :q 或 Ctrl-D：退出程序
• :c 或 Ctrl-C：清除当前对话历史
• :r 或 Ctrl-R：重新生成上一条回复
• 输入 \ 后回车：进入多行输入模式（按 ESC 然后 Enter 退出）

使用特定助手

工具内置了针对不同场景优化的助手：

• 通用助手（默认）：

  gpt general
  

• 开发助手（回答更简洁，适合编程）：

  gpt dev
  

• Bash 专家（仅生成 Shell 命令，配合 -e 可直接执行）：

  gpt bash -e "如何列出当前目录下的文件？"
  

  执行前会在编辑器中打开命令供你确认修改。

指定模型与参数

你可以临时覆盖默认模型或调整参数：

gpt --model gpt-4 --temperature 0.7 --prompt "解释一下量子纠缠"

启用 Claude 3.7 的扩展思维模式（Extended Thinking）：

gpt --model claude-3-7-sonnet-20250219 --thinking 32000

非交互式调用

直接输出结果而不进入交互模式，适合脚本集成：

gpt --prompt "计算 123 * 456" --no_markdown