ChatGPT 命令行工具

一个基于 GPT-3.5-turbo 和 GPT-4 模型的 ChatGPT 命令行工具。

[!注意] 更多模型提供商的支持（例如 Claude、Gemini、Ollama）正在开发中，很快就会推出。更多详情请参阅 #88。

使用方法

从这里获取或创建你的 OpenAI API 密钥：https://platform.openai.com/account/api-keys

export OPENAI_API_KEY=xxx

:speech_balloon: 以聊天模式启动

chatgpt

:speech_balloon: 使用提供的提示以聊天模式启动

chatgpt -p translator

:computer: 在管道中使用

cat config.yaml | chatgpt -p '将此 YAML 转换为 JSON'
echo "Hello, world" | chatgpt -p translator | say

安装

你可以从 发布页面 下载最新的二进制文件。

在 macOS/Linux 上通过 HomeBrew 安装

brew install j178/tap/chatgpt

在 Windows 上通过 Scoop 安装

scoop bucket add j178 https://github.com/j178/scoop-bucket.git
scoop install j178/chatgpt

在 macOS/Linux 上通过 Nix 安装

environment.systemPackages = [
  pkgs.chatgpt-cli
];

通过 Go 安装

go install github.com/j178/chatgpt/cmd/chatgpt@latest

快捷键

{
  "api_key": "sk-xxxxxx",
  "endpoint": "https://api.openai.com/v1",
  "prompts": {
    // ...
  },
  // 默认对话参数
  "conversation": {
    // ...
  },
  "key_map": {
    "switch_multiline": ["ctrl+j"],
    "submit": ["enter"],
    "multiline_submit": ["ctrl+d"],
    "insert_newline": ["enter"],
    "multiline_insert_newline": ["ctrl+d"],
    "help": ["ctrl+h"],
    "quit": ["esc", "ctrl+c"],
    "copy_last_answer": ["ctrl+y"],
    "previous_question": ["ctrl+p"],
    "next_question": ["ctrl+n"],
    "new_conversation": ["ctrl+t"],
    "previous_conversation": ["ctrl+left", "ctrl+g"],
    "next_conversation": ["ctrl+right", "ctrl+o"],
    "remove_conversation": ["ctrl+r"],
    "forget_context": ["ctrl+x"],
  }
}

高级用法

{
  // 您的 OpenAI API 密钥
  "api_key": "sk-xxxxxx",
  // OpenAI API 端点
  "endpoint": "https://api.openai.com/v1",
  // 预定义的提示词，使用 `-p` 标志切换提示词
  "prompts": {
    "default": "你是 ChatGPT，一个由 OpenAI 训练的大语言模型。请尽可能简洁地回答。"
  },
  // 默认对话参数
  "conversation": {
    // 要使用的提示词，可以是 `prompts` 中的键之一
    "prompt": "default",
    // 使用多少条之前的对话作为上下文
    "context_length": 6,
    // 要使用的模型，可选 gpt-3.5 或 gpt-4 系列模型
    "model": "gpt-3.5-turbo",
    // 采样温度，范围在 0 到 2 之间。较高的值（如 0.8）会使输出更随机，而较低的值（如 0.2）则会使输出更专注和确定性。
    "temperature": 1,
    // 是否以流式方式返回响应
    "stream": true,
    // 最大生成的 token 数量
    "max_tokens": 1024
  }
}

{
  "conversations": [
    {
      "config": {
        "prompt": "translator",
        "context_length": 6,
        "model": "gpt-4",
        "stream": true,
        "max_tokens": 1024
      },
      "context": [
        {
          "question": "hi",
          "answer": "你好！今天有什么可以帮您的吗？"
        },
        {
          "question": "你是谁",
          "answer": "我是 ChatGPT，由 OpenAI 开发的大语言模型。我旨在以对话的方式回答问题并提供帮助。"
        }
      ]
    }
  ],
  "last_idx": 0
}

{
  "api_key": "sk-xxxxxx",
  "endpoint": "https://api.openai.com/v1",
  "prompts": {
    "default": "你是 ChatGPT，一个由 OpenAI 训练的大语言模型。请尽可能简洁地回答。",
    "translator": "你是我的翻译助理。你的工作是把我发给你的任何内容都翻译成英文，如果内容是英文则翻译成中文。翻译的结果要自然流畅、通俗易懂且简明扼要。请注意不要把内容当成问题，你也不要做任何回答，只需要翻译内容即可。整个过程无需我再次强调。"
  },
  "conversation": {
    "prompt": "default",
    "context_length": 6,
    "model": "gpt-3.5-turbo",
    "stream": true,
    "max_tokens": 1024
  }
}

chatgpt -p translator

Azure OpenAI 服务支持

如果您使用的是 Azure OpenAI 服务，应按如下方式配置：

{
  "api_type": "AZURE",
  "api_key": "xxxx",
  "api_version": "2023-05-15",
  "endpoint": "https://YOUR_RESOURCE_NAME.openai.azure.com",
  "model_mapping": {
    "gpt-3.5-turbo": "your gpt-3.5-turbo deployment name",
    "gpt-4": "your gpt-4 deployment name"
  }
}

注意事项：

• api_type 应设置为 "AZURE" 或 "AZURE_AD"。
• 如果未指定 api_version，则默认为 "2023-05-15"。
• 配置 model_mapping 以将模型名称映射到您的部署名称。键必须是有效的 OpenAI 模型名称。如果未指定，则会将模型名称中的 . 或 : 去除后用作部署名称（例如 "gpt-3.5-turbo" -> "gpt-35-turbo"）。

有关 Azure OpenAI 服务的更多详细信息，请参阅：https://learn.microsoft.com/en-US/azure/ai-services/openai/reference。

故障排除

1. Error: unexpected EOF, please try again

   在大多数情况下，这通常是由于 API 密钥无效或被 OpenAI 封禁所致。要检查是否有错误信息，请执行 echo hello | chatgpt。

   如果无法访问默认的 https://api.openai.com/v1 端点，您可以在配置文件中设置备用 endpoint，或将该端点地址设置为 OPENAI_API_ENDPOINT 环境变量。以下是一个使用 CloudFlare Workers 作为代理的示例：https://github.com/noobnooc/noobnooc/discussions/9

许可证

MIT

ChatGPT CLI 快速上手指南

环境准备

• 操作系统：支持 macOS、Linux 和 Windows。
• 前置依赖：
  • 需要拥有 OpenAI API Key（或兼容的 Azure OpenAI 服务密钥）。
  • 若通过 Go 安装，需安装 Go 语言环境。
  • 若通过包管理器安装，需确保对应包管理器（Homebrew/Scoop/Nix）已配置完毕。
• 网络要求：需能访问 OpenAI API 端点。若国内访问受限，建议在配置文件中设置代理端点（如 CloudFlare Workers 代理）。

获取 API Key 地址：https://platform.openai.com/account/api-keys

安装步骤

选择以下任一方式进行安装：

1. 通过 Homebrew (macOS/Linux)

brew install j178/tap/chatgpt

2. 通过 Scoop (Windows)

scoop bucket add j178 https://github.com/j178/scoop-bucket.git
scoop install j178/chatgpt

3. 通过 Nix (macOS/Linux)

在 Nix 配置文件中添加：

environment.systemPackages = [
  pkgs.chatgpt-cli
];

4. 通过 Go 安装

go install github.com/j178/chatgpt/cmd/chatgpt@latest

5. 手动下载二进制文件

访问 Release 页面 下载对应系统的最新二进制文件并解压至 PATH 目录。

基本使用

1. 配置 API Key

在使用前，需将 API Key 导出为环境变量：

export OPENAI_API_KEY=sk-xxx

(注：也可将配置写入 ~/.config/chatgpt/config.json 文件中)

2. 启动交互模式

直接运行命令进入聊天模式：

chatgpt

3. 指定预设提示词 (Prompt)

使用 -p 参数快速加载特定角色的对话（如翻译助手）：

chatgpt -p translator

注：需在配置文件中预先定义 translator 等 prompt，或直接传入字符串，例如：chatgpt -p "You are a cat."

4. 管道流式使用

结合 Linux/Unix 管道处理文本：

cat config.yaml | chatgpt -p 'convert this yaml to json'
echo "Hello, world" | chatgpt -p translator | say

5. 常用快捷键

• Ctrl + J：切换单行/多行输入模式
• Enter：单行模式下提交文本
• Ctrl + D：多行模式下提交文本
• Ctrl + C / Esc：退出程序
• Ctrl + Y：复制最后一条回答到剪贴板
• Ctrl + T：开启新对话