官方网站 OpenAI REST API 的 CLI. 安装 使用 Homebrew 安装 brew install openai/tools/openai 使用 Go 安装 要在本地测试或安装 CLI，您需要安装 Go 版本 1.26 或更高。 go install ' github.com/openai/openai-cli/cmd/openai@latest ' 一旦您运行了 go install，二进制文件将放置在您的 Go bin 目录中： 默认位置：$HOME/go/bin（或如果设置了 GOPATH，则为 $GOPATH/bin） 检查您的路径：运行 go env GOPATH 以查看基础目录 如果在安装后找不到命令，请将 Go bin 目录添加到您的 PATH： # 添加到您的 shell 配置文件（.zshrc、.bashrc 等） export PATH=" $PATH : $( go env GOPATH ) /bin " 第一个合格的交互式 openai 运行会悄悄保存图像选择器 Tab 快捷键以供未来的 Bash、zsh 和 fish 会话使用。打开一个新终端以使用它们。请参阅快捷方式设置和移除以了解要求和选择退出。 PowerShell 保持正常的 Tab 补全；在 openai images generate 后按 Enter 以打开选择器。 更新通知 Bare openai 在 stdin、stdout 和 stderr 为终端时检查更新的稳定版本。它会在帮助之下添加一条纯文本通知，最多每七天一次。 显式帮助、命令、补全、CI 和重定向流完全跳过检查。 通知包括更新命令，当 CLI 能够验证其安装方法时。 已验证的 Homebrew 安装使用 brew upgrade --cask openai/tools/openai 。 Go 命令需要已验证的二进制文件、可用的 Go 命令和显式匹配的 GOBIN 。 自定义 GOOS 或 GOARCH 设置选择安装指南。Go 升级到主要版本 2 或更高也会选择安装指南。 未知的安装将收到安装指南链接。 CLI 从不自动安装更新。检查使用公共 GitHub 发布元数据而不需要 API 凭证，最多每天一次。 检查遵循 HTTPS_PROXY 和 NO_PROXY，包括它们的小写形式。 更新发现最多等待 200 毫秒。 失败的检查保持沉默。 软件包管理器的可用性可能会滞后于新的 GitHub 发布。 设置 OPENAI_CLI_NO_UPDATE_CHECK=1 以禁用检查和通知。 本地运行 在克隆该项目的 git 仓库后，您可以使用 scripts/run 脚本在本地运行该工具： ./scripts/run args... 用法 CLI 遵循基于资源的命令结构： openai < resource > [subresource...] < command > [flags...] 标准 API 端点需要 API 密钥： export OPENAI_API_KEY=" sk-... " openai responses create \ --input " Say this is a test " \ --model gpt-5.5 管理端点需要管理员 API 密钥： export OPENAI_ADMIN_KEY=" sk-admin-... " openai admin organization usage completions \ --start-time 1735689600 \ --end-time 1735776000 \ --bucket-width 1d 使用 --help 浏览每个组，例如 openai admin --help 或 openai admin organization --help。 现有的冒号命令例如 openai admin:organization:usage completions 继续有效。 运行 openai 按任务浏览命令组，并为每个组提供描述。 组帮助将动作与嵌套命令组分开，并列出每个直接命令。帮助在没有 API 密钥或网络连接的情况下有效： openai help setup # 安全输入您的 API 密钥 openai images generate --help # 示例和每个图像选项 openai help images generate # 完整的图像帮助 openai --help # 命令组和全局选项 将 --help（或 -h）添加到任何命令以获取其完整帮助页面。openai help COMMAND 显示同一页面。 命令页面列出全局选项。使用 openai --help 获取其完整描述。您可以将 --help 放在有效命令选项之后。 旧的帮助 --all 拼写打印迁移指导和完整页面。 命令行为、默认值和输出格式保持不变。 标签补全遵循相同的组顺序，并支持帮助主题和文件输入路径。升级后，重新加载 shell 补全以启用新的文件路径行为。较旧加载的补全脚本在刷新之前保留其先前行为。 启用命令插入，以便从示例、设置指导和恢复命令填充您的命令行。Ctrl+X，然后 Tab 搜索建议而不运行它们。双 Tab 是 Bash、zsh 和 fish 的可选绑定。 成功的 JSON 响应默认打印可读文本，包括在管道中。使用 --format json 或 --format jsonl 在解析 API 数据的脚本中。 请参阅读取命令结果以了解提取、二进制输出和可读呈现的范围。 上传具有明确目的的本地文件，检查其元数据，然后下载其内容： openai files upload " upload space.txt " --purpose user_data openai files get file-example openai files download file-example --output " downloaded copy.txt " openai files download file-example > copy.txt 将 file-example 替换为返回的文件 ID。上传采用普通路径，未添加 @ . create、retrieve、content 和它们现有的标志仍然可用。请参阅处理文件以获取字面文件名。