Guía técnica del CLI oficial de OpenAI para la API REST

Fuentes: Technical guide to the official OpenAI CLI for the REST API

El openai-cli es la herramienta de línea de comandos oficial desarrollada por OpenAI para interactuar con su API REST. Diseñada para desarrolladores que buscan una integración más fluida en sus flujos de trabajo de terminal, esta utilidad permite ejecutar comandos, gestionar archivos y visualizar resultados de forma estructurada. El software, escrito en Go, requiere la versión 1.26 o superior para su instalación local mediante el gestor de paquetes de Go, aunque también está disponible a través de Homebrew para macOS.

La arquitectura del CLI sigue una estructura basada en recursos, donde los comandos se organizan por grupos funcionales, como 'images' para generación de gráficos o 'admin' para gestión de organizaciones. La herramienta exige la autenticación mediante claves API (OPENAI_API_KEY) o claves de administración, que pueden configurarse a través de variables de entorno o parámetros de línea de comandos. Un aspecto destacado es la gestión de actualizaciones: el CLI verifica automáticamente la disponibilidad de nuevas versiones estables mediante metadatos públicos de GitHub, pero no instala actualizaciones automáticamente para evitar conflictos de dependencias. Los usuarios pueden desactivar estas comprobaciones mediante la variable OPENAI_CLI_NO_UPDATE_CHECK=1.

En cuanto a la salida de datos, el CLI prioriza la legibilidad humana por defecto, imprimiendo resultados JSON formateados de forma legible incluso en pipelines. Sin embargo, ofrece opciones para generar salida binaria o JSON crudo mediante flags como --format json o --format jsonl, lo que facilita el parseo en scripts. La herramienta incluye funciones avanzadas como la generación de imágenes con opciones de guardado local y la gestión de archivos con metadatos explícitos. La documentación detalla también la configuración de autocompletado en Bash, zsh y fish, así como la gestión de errores mediante resúmenes accionables en stderr o detalles JSON detallados.