
openai-cli
终端一条命令,直接调通 OpenAI 模型
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-11-09 · 当前星标 ★ 1154
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- macOS 且已安装 Homebrew(使用 zsh 或其它 shell)
- Linux:Debian、Ubuntu 或 Fedora,使用 Bash 或 zsh
- 调用 API 时需要 OpenAI API 密钥
- 安装与调用 API 时需要网络连接(仅查看帮助则不需要)
安装与启动步骤
-
1macOS 安装
在终端把两行命令一起粘贴执行:第一行更新 Homebrew 并安装 openai,第二行启用自动更新。
brew update && brew install --cask openai/tools/openai && source "$(brew --prefix)/bin/openai-enable-updates.zsh" -
2Linux 安装
从 Releases 下载 openai.sh,在下载目录打开 Bash 或 zsh,按脚本页面给出的两行内容执行安装。
-
3查看总帮助
确认命令已可用,并浏览资源(resource)与子命令结构;帮助不需要 API 密钥和网络。
openai --help -
4查看具体命令帮助
命令按 API 资源组织,用 --help 查看某个动作的用法、必填输入和相关参数。
openai images generate --help -
5配置 API 密钥
调用 API 前需通过环境变量提供密钥,具体变量名与写法以官方 CLI 参考文档为准。
-
6批量请求示例
上传 JSONL 请求文件、创建批次并等待结果下载到 ./results,文件与批次 ID 换成返回值。
openai files upload requests.jsonl --purpose batch openai batches create --input-file-id file-example --endpoint /v1/responses --completion-window 24h openai batches wait batch_example --output-dir ./results
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | 通过环境变量向 CLI 提供 API 密钥,具体名称以官方文档为准 | sk-xxxxxxxx |
如何确认成功
执行 openai --help 能正常列出资源与子命令,即表示安装成功;该命令无需密钥和网络。
常见问题
Q:查看帮助需要 API 密钥或联网吗?
A:不需要。README 明确说明帮助命令既不读取 API 密钥,也不需要网络连接,可用来先验证安装结果。
Q:openai help COMMAND 和 openai COMMAND --help 有区别吗?
A:没有区别,两者展示同一页帮助;命令组会列出可用命令,具体动作会显示用法、必填输入和相关参数。
Q:如何只查看某个参数的说明?
A:把参数追加在 -h 之后,例如 openai responses create -h --stream;查看全部参数说明用 openai help --all responses create。
Q:旧的冒号分隔命令还能用吗?
A:可以。像 openai admin:organization:usage completions 这类冒号分隔写法仍然有效。
Q:安装后会自动更新吗?
A:正常交互使用会自动更新,具体触发时机见 docs/automatic-updates.md;macOS 安装需执行第二行 source 命令启用。
注意事项
- macOS 的两行命令要一起粘贴执行,缺少第二行不会启用自动更新。
- Linux 安装脚本的完整命令与校验值在 README 节选中被截断,请以 Releases 页面和 docs/installation.md 为准。
- 需要写代码的智能体场景请改用 Codex CLI,而不是本项目。
- 调用接口前先配好密钥环境变量,避免请求被拒绝。
核心亮点
- 官方维护,接口与 OpenAI API 保持同步,兼容性有保障
- Go 单二进制分发,安装轻量,适合服务器和 CI 环境
- 命令输出可管道化,便于嵌入 shell 脚本和自动化流程
不足之处
- 功能围绕 API 调用封装,复杂业务逻辑仍需自行编写脚本
- 文档和社区生态相对早期,示例与最佳实践较少
适用场景
- 在终端快速测试提示词和模型参数效果
- CI/CD 流水线中调用模型做文本处理或校验
- 服务器运维脚本中批量调用 API 处理数据
替代项目
llm、aichat、mods
上一篇:skills
下一篇:openai-ruby
同类项目推荐
parallel-code
开源
同时跑多个AI编程助手,各干各的互不干扰
Run Claude Code, Codex, and Gemini side by side — each in its own git worktree
run
开源
给 AI 智能体安全跑代码,替代裸 eval
A secure and efficient alternative to `eval` for coding agents
hindsight
开源
会话结束自动复盘,只留可复用经验,让 AI 越用越少踩坑。
A self-improvement skill for AI coding assistants — reviews a session end-to-end an···
opencode-plusplus
开源
给 AI 编程装上安全护栏,让代码变更更可靠、可追溯。
OpenCode++: a Coding Agent Reliability Harness for OpenCode, adding context, edit bo···
local-ai-code-assistant
开源
在自己电脑上跑 Claude 写代码,数据不出本机
Local AI Coding Hub: Run Claude Models Offline in 2026
eca-emacs
开源
在 Emacs 里直接召唤 AI 写代码、改代码
Editor Code Assistant (ECA) integration for Emacs
project-codeguard
开源
给 AI 写代码加一道默认安全护栏
Project CodeGuard is an open-source, model-agnostic security framework that embeds s···
ai-commits-intellij-plugin
开源
在 IntelliJ 里一键生成规范 Git 提交信息,告别憋字
AI Commits for IntelliJ based IDEs/Android Studio.
codegraph
开源
给 AI 编程助手一张实时更新的代码地图
Pre-indexed code knowledge graph, auto syncs on code changes, for Claude Code, Codex···