Repolode
openai

openai/openai-cli

Cliente oficial de línea de comandos para la API REST de OpenAI, con comandos por recurso para modelos, respuestas, archivos, imágenes y endpoints de administración.

Estrellas
767
Forks
79
Issues abiertos
27
Último commit
hace 4 horas

¿Qué es?

openai-cli es la interfaz oficial de línea de comandos para la API REST de OpenAI, escrita en Go. Organiza los comandos por recurso, así que se usa `openai <resource> <command>` para operaciones como crear respuestas, subir y descargar archivos, y generar imágenes. Los endpoints estándar se autentican con una API key, mientras que los endpoints de administración usan una clave de administrador independiente.

Además de las llamadas directas a la API, la CLI muestra texto legible de forma predeterminada y ofrece formatos JSON, JSONL y YAML para scripts. La opción `--transform` extrae campos mediante la sintaxis de GJSON, y los errores se pueden formatear o extraer por separado. La generación de imágenes guarda los resultados en un directorio local e imprime sus rutas, y hay autocompletado de comandos disponible para Bash, zsh, fish y PowerShell.

La herramienta se puede instalar con Homebrew o `go install`, y admite URL base personalizadas, encabezados de solicitud adicionales y certificados de cliente mTLS para las organizaciones que los usan.

Funciones clave

  • 01Comandos organizados por recurso para los endpoints de la API de OpenAI, incluidos los endpoints de administración, que usan una clave independiente.
  • 02Texto legible de forma predeterminada, con formatos JSON, JSONL y YAML para scripts.
  • 03Opción `--transform` basada en GJSON para extraer campos de respuestas y errores.
  • 04Generación de imágenes que guarda los resultados localmente e imprime las rutas de los archivos.
  • 05Autocompletado de comandos y sugerencias integradas para la línea de comandos.
  • 06Compatibilidad con URL base personalizadas, encabezados de solicitud y certificados de cliente mTLS.

Casos de uso

  • Llamar a modelos de OpenAI o subir archivos desde la terminal durante el desarrollo o la depuración.
  • Crear scripts para flujos de trabajo de la API que procesen la salida JSON en tuberías de shell o trabajos de CI.
  • Generar imágenes desde la línea de comandos y guardarlas en una carpeta local.
  • Ejecutar consultas administrativas de uso de una organización desde la terminal.

Inicio rápido

  1. 1

    Instalar con Homebrew

    brew install openai/tools/openai
  2. 2

    O instalar con Go (se requiere Go 1.26 o posterior)

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

    Configurar la clave de API en el entorno

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

    Ejecutar una primera solicitud, por ejemplo, crear una respuesta

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

Antes de usarlo

  • Los comandos estándar de la API requieren una clave de API de OpenAI, lo que puede generar costos de uso.
  • La instalación con Go requiere Go 1.26 o posterior.

Temas

Preguntas frecuentes

¿Qué es openai-cli?
Cliente oficial de línea de comandos para la API REST de OpenAI, con comandos por recurso para modelos, respuestas, archivos, imágenes y endpoints de administración. openai-cli es la interfaz oficial de línea de comandos para la API REST de OpenAI, escrita en Go. Organiza los comandos por recurso, así que se usa `openai <resource> <command>` para operaciones como crear respuestas, subir y descargar archivos, y generar imágenes. Los endpoints estándar se autentican con una API key, mientras que los endpoints de administración usan una clave de administrador independiente.
¿openai-cli es gratuito? ¿Qué licencia tiene?
openai-cli es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿openai-cli sigue mantenido?
Mantenimiento activo. El último commit de openai-cli fue el 22 oct 2026.
¿Para qué puedo usar openai-cli?
Llamar a modelos de OpenAI o subir archivos desde la terminal durante el desarrollo o la depuración. Crear scripts para flujos de trabajo de la API que procesen la salida JSON en tuberías de shell o trabajos de CI. Generar imágenes desde la línea de comandos y guardarlas en una carpeta local. Ejecutar consultas administrativas de uso de una organización desde la terminal.
¿Cómo se instala openai-cli?
Instalar con Homebrew: brew install openai/tools/openai O instalar con Go (se requiere Go 1.26 o posterior): go install 'github.com/openai/openai-cli/cmd/openai@latest' Configurar la clave de API en el entorno: export OPENAI_API_KEY="sk-..." Ejecutar una primera solicitud, por ejemplo, crear una respuesta: openai responses create --input "Say this is a test" --model gpt-5.5
¿Dónde consigo openai-cli?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/openai/openai-cli

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados