Repolode
openai

openai/openai-cli

OpenAI 官方命令行工具,以资源分组的方式调用 OpenAI REST API。

Star
767
Fork
79
未关闭 Issue
27
最近提交
4小时前

这是什么?

openai-cli 是 OpenAI REST API 的官方命令行工具,使用 Go 编写。命令按资源组织,例如 `openai <resource> <command>`,可用于创建 responses、上传和下载文件、生成图片等操作。标准接口使用 API 密钥认证,管理接口则使用单独的 admin 密钥。

除了直接调用接口,默认输出为易读的文本,同时提供 JSON、JSONL 和 YAML 格式便于脚本处理。`--transform` 参数支持用 GJSON 语法提取字段,错误输出也可单独格式化或提取。生成的图片会保存到本地目录并打印路径,并支持 Bash、zsh、fish 和 PowerShell 的 Tab 补全。

可通过 Homebrew 或 `go install` 安装。工具还支持自定义 Base URL、附加请求头,以及用于双向 TLS 认证的客户端证书。

核心功能

  • 01按资源分组的 OpenAI API 命令,管理接口使用独立密钥。
  • 02默认输出易读文本,并提供 JSON、JSONL、YAML 格式供脚本使用。
  • 03基于 GJSON 语法的 `--transform` 参数,可提取响应和错误中的字段。
  • 04图片生成结果保存到本地并打印文件路径。
  • 05支持 Shell Tab 补全和命令提示。
  • 06支持自定义 Base URL、请求头以及双向 TLS 客户端证书。

适用场景

  • 在终端中调试或测试 OpenAI 模型调用和文件上传。
  • 在 shell 管道或 CI 任务中解析 JSON 输出,编排 API 工作流。
  • 在命令行生成图片并保存到本地目录。
  • 在终端中查询组织的管理用量数据。

快速上手

  1. 1

    使用 Homebrew 安装

    brew install openai/tools/openai
  2. 2

    或使用 Go 安装(需要 Go 1.26 或更高版本)

    go install 'github.com/openai/openai-cli/cmd/openai@latest'
  3. 3

    在环境变量中设置你的 API 密钥

    export OPENAI_API_KEY="sk-..."
  4. 4

    运行第一个请求,例如创建一个 response

    openai responses create --input "Say this is a test" --model gpt-5.5

使用前须知

  • 标准 API 命令需要 OpenAI API 密钥,使用可能产生费用。
  • 通过 Go 安装需要 Go 1.26 或更高版本。

标签

常见问题

openai-cli 是什么?
OpenAI 官方命令行工具,以资源分组的方式调用 OpenAI REST API。 openai-cli 是 OpenAI REST API 的官方命令行工具,使用 Go 编写。命令按资源组织,例如 `openai <resource> <command>`,可用于创建 responses、上传和下载文件、生成图片等操作。标准接口使用 API 密钥认证,管理接口则使用单独的 admin 密钥。
openai-cli 可以免费使用吗?用的什么许可证?
openai-cli 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
openai-cli 还在维护吗?
活跃维护中。openai-cli 最近一次提交是在 2026年10月22日。
openai-cli 适合用来做什么?
在终端中调试或测试 OpenAI 模型调用和文件上传。 在 shell 管道或 CI 任务中解析 JSON 输出,编排 API 工作流。 在命令行生成图片并保存到本地目录。 在终端中查询组织的管理用量数据。
openai-cli 怎么安装和运行?
使用 Homebrew 安装: brew install openai/tools/openai 或使用 Go 安装(需要 Go 1.26 或更高版本): go install 'github.com/openai/openai-cli/cmd/openai@latest' 在环境变量中设置你的 API 密钥: export OPENAI_API_KEY="sk-..." 运行第一个请求,例如创建一个 response: openai responses create --input "Say this is a test" --model gpt-5.5
在哪里获取 openai-cli?
源代码和安装说明在 GitHub 上:https://github.com/openai/openai-cli

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目