tldr-pages 中的 openai 速查页全解析：用 `openai` 命令行工具调用 OpenAI API 的实践指南

• 文档
• 教程
• 知识库

本文以 tldr-pages 仓库中的openai页面为骨架，逐条拆解其四个核心命令示例（列出模型、文本补全、对话补全、DALL·E 图像生成），并结合本仓库的页面规范、占位符语法、多语言翻译规则与客户端使用方式，帮助读者快速掌握openaiCLI 的常见用法，同时理解这份速查页是如何被编写、校验与渲染的。

页面速览：这张速查页讲了什么

openai是一个提供 OpenAI API 访问能力的命令行工具，其速查页被收录在 tldr-pages 的common平台目录下（英文原版），意味着该命令在多个平台上用法一致，不绑定任何特定操作系统。

页面在标题下方的描述行中明确写道："CLI tool providing access to the OpenAI API"（一个提供 OpenAI API 访问能力的 CLI 工具），并在 More information 行中指向openai-python项目——也就是说，这里的openai命令指的就是官方 Python SDK 附带的可执行入口，而不是其他同名工具。

整个页面仅用一个 H1 标题、一段描述和四条示例命令，构成了完整的速查信息：

命令逐条详解：四类常见 API 调用

列出可用模型

openai api models.list

models.list对应 OpenAI API 的模型列表端点，是最简单的探测性命令。执行后终端会返回账号有权访问的模型标识列表，可用于确认账号权限、核对可用模型名称，为后续--model参数提供取值依据。

创建文本补全

openai api completions.create --model {{ada}} --prompt "{{Hello world}}"

completions.create用于创建文本补全。这里有两个关键参数：

• --model：指定使用的模型，页面示例以{{ada}}作为占位符——它是 OpenAI 早期系列中成本较低、速度较快的模型之一，适合作为快速验证用法的示例值；
• --prompt：传入的提示文本，被{{Hello world}}占位符包裹。按 tldr 规范，接收字符串的占位符建议整体放进引号内，即"{{Hello world}}"，保证提示文本中的空格等字符被正确传递。

创建对话补全

openai api chat_completions.create --model {{gpt-3.5-turbo}} --message {{user "Hello world"}}

chat_completions.create面向对话式场景，页面示例使用{{gpt-3.5-turbo}}作为模型占位符。与文本补全不同的是，对话补全需要以"角色 + 内容"的结构传入消息，示例中的{{user "Hello world"}}即表示"用户角色说了一句 Hello world"——user指定消息来源角色，后跟该角色的消息内容。熟悉这一结构后，就可以扩展出多轮消息（例如追加assistant角色的历史回复），从而构造真正的多轮对话。

通过 DALL·E API 生成图像

openai api image.create --prompt "{{كلبان يلعبان الشطرنج، كرتوني}}" --num-images {{1}}

image.create调用 DALL·E 图像生成接口，--prompt传入图像描述，--num-images指定生成张数（示例为 1）。值得注意的是，阿拉伯语版本中的提示词占位符使用了本地化文本"كلبان يلعبان الشطرنج، كرتوني"（两只狗在下国际象棋，卡通风格），对应的英文原版则是{{two dogs playing chess, cartoon}}——提示词本身是面向模型的自然语言，因此翻译页面会将其本地化，以便母语读者直观理解可用什么样的描述。

多语言版本与阿拉伯语翻译的特殊规则

openai页面在本仓库中目前存有三个版本，分别位于：

• pages/common/openai.md（英文原版）
• pages.ar/common/openai.md（阿拉伯语）
• pages.ko/common/openai.md（韩语）

其中阿拉伯语版是本篇关联文档。根据仓库的通用占位符对照表中的明确提示：阿拉伯语（ar）和波斯语（fa）页面中的占位符不应被翻译，以防止阅读时出现反向文本（RTL 语言下占位符翻转导致的可读性问题）。观察 pages.ar/common/openai.md 可以看到，{{ada}}、{{gpt-3.5-turbo}}、{{Hello world}}等占位符均保留英文原样，这与该规则完全一致；阿拉伯语样式指南也强调"不要将{{path/to/file}}之类的占位符翻译为{{المسار/إلى/الملف}}以免造成混淆"。

速查页背后的格式规范

这张页面严格遵循仓库通用样式指南的模板：

• 页面首行为# 命令名，且文件名与命令名保持一致（全部小写）；
• >开头的行承载描述与 More information 链接；
• 每条示例由一行"动词开头的祈使句描述"和一行反引号包裹的命令组成；
• 整个页面最多 8 条示例。

占位符是 tldr 页面最核心的语法元素：

客户端会将这些{{ }}包裹的部分高亮显示，帮助用户一眼定位需要替换的位置。仓库还通过tldr-lint（见 package.json 中的依赖与 lint 脚本）在每次提交时自动校验页面格式，读者也可以在本地安装后检查任意页面：

npm install --global tldr-lint tldr-lint pages/common/openai.md

如何实际使用这张速查页

仓库 README.md 提供了多种官方客户端安装方式，例如：

pipx install tldr # Python 客户端 brew install tlrc # Rust 客户端（macOS/Linux） cargo install tlrc --locked winget install tldr-pages.tlrc # Windows 上的 Rust 客户端 npm install -g tldr # Node.js 客户端

安装完成后，直接执行tldr openai即可在终端看到本文所述的速查页内容。客户端还会根据当前平台自动选择最合适的页面变体；由于openai位于common目录，它会在所有平台上被展示。此外，按客户端规范：

tldr --platform common openai # 强制使用 common 平台的页面 tldr --render pages/common/openai.md # 在本地预览某个页面文件 tldr -l # 列出当前平台的所有页面

其中--render对贡献者尤其有用——修改页面后可以先本地预览再提交。

仓库中的其他 AI 命令行工具页面

在 tldr-pages 仓库中，openai页面并非孤例，common目录下还有若干与 AI 工具相关的速查页可以对照阅读：

• llm：通过远程 API 与本地模型交互的通用 LLM 工具，其页面包含llm keys set openai（设置 OpenAI API Key）、llm "prompt"等示例；
• tgpt：无需 API Key 即可对话的 AI 聊天工具，页面列出了openai、opengpts、llama2等 provider，并演示了如何通过--provider openai --key ... --model gpt-3.5-turbo显式指定 OpenAI 后端。

这些页面与openai页面共同构成了仓库中"通过命令行使用大模型"的速查矩阵，读者可以横向对比不同工具的调用方式差异。

结语

openai速查页虽然只有四条示例，却完整覆盖了 OpenAI API 最常用的三类能力：模型查询、文本/对话生成与图像生成。它既是 tldr-pages 页面格式规范的一个典型范本（占位符、祈使句描述、More information 链接一应俱全），也是阿拉伯语等 RTL 语言翻译规则的实际体现。通过本篇文章，读者既能直接上手tldr openai完成 API 调用，也能理解这份速查页在仓库中的编写逻辑，进而举一反三地阅读与贡献其他 tldr 页面。

• 文档
• 教程
• 知识库