A biblioteca oficial de Python para a REST API da OpenAI, com clientes síncronos e assíncronos e modelos tipados para requisições e respostas.
openai/openai-cli
Cliente oficial de linha de comando para a API REST da OpenAI, com comandos por recurso para modelos, respostas, arquivos, imagens e endpoints administrativos.
- Estrelas
- 767
- Forks
- 79
- Issues abertas
- 27
- Último commit
- há 5 horas
O que é?
openai-cli é a interface oficial de linha de comando para a API REST da OpenAI, escrita em Go. Os comandos são organizados por recurso, então você executa `openai <resource> <command>` para operações como criar respostas, enviar e baixar arquivos e gerar imagens. Os endpoints padrão usam uma API key para autenticação, enquanto os endpoints administrativos usam uma admin key separada.
Além de fazer chamadas diretas à API, a CLI exibe texto legível por padrão e oferece os formatos JSON, JSONL e YAML para scripts. A flag `--transform` extrai campos usando a sintaxe do GJSON, e a saída de erros pode ser formatada ou extraída separadamente. A geração de imagens salva os resultados em um diretório local e imprime os caminhos dos arquivos. Também há preenchimento automático de comandos para Bash, zsh, fish e PowerShell.
A ferramenta pode ser instalada com Homebrew ou `go install` e oferece suporte a URLs base personalizadas, cabeçalhos de requisição extras e certificados de cliente mTLS para organizações que os utilizam.
Recursos principais
- 01Comandos organizados por recurso para endpoints da API da OpenAI, incluindo endpoints administrativos que usam uma chave separada.
- 02Texto legível por padrão, com formatos JSON, JSONL e YAML para scripts.
- 03`--transform` baseado em GJSON para extrair campos de respostas e erros.
- 04Geração de imagens que salva os resultados localmente e imprime os caminhos dos arquivos.
- 05Preenchimento automático de comandos no shell e sugestões de comandos em linha.
- 06Suporte a URL base personalizada, cabeçalhos de requisição e certificados de cliente mTLS.
Casos de uso
- Chamar modelos da OpenAI ou enviar arquivos pelo terminal durante o desenvolvimento ou a depuração.
- Criar scripts de fluxos de trabalho da API que processem a saída JSON em pipelines de shell ou jobs de CI.
- Gerar imagens pela linha de comando e salvá-las em uma pasta local.
- Executar consultas administrativas de uso de uma organização pelo terminal.
Início rápido
- 1
Instale com Homebrew
brew install openai/tools/openai - 2
Ou instale com Go (requer Go 1.26 ou posterior)
go install 'github.com/openai/openai-cli/cmd/openai@latest' - 3
Defina sua chave de API no ambiente
export OPENAI_API_KEY="sk-..." - 4
Faça uma primeira solicitação, por exemplo, criando uma resposta
openai responses create --input "Say this is a test" --model gpt-5.5
Antes de usar
- Os comandos padrão da API exigem uma chave de API da OpenAI, o que pode gerar custos de uso.
- A instalação com Go requer Go 1.26 ou posterior.
Tópicos
Perguntas frequentes
- O que é openai-cli?
- Cliente oficial de linha de comando para a API REST da OpenAI, com comandos por recurso para modelos, respostas, arquivos, imagens e endpoints administrativos. openai-cli é a interface oficial de linha de comando para a API REST da OpenAI, escrita em Go. Os comandos são organizados por recurso, então você executa `openai <resource> <command>` para operações como criar respostas, enviar e baixar arquivos e gerar imagens. Os endpoints padrão usam uma API key para autenticação, enquanto os endpoints administrativos usam uma admin key separada.
- openai-cli é gratuito? Qual é a licença?
- openai-cli é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
- openai-cli ainda é mantido?
- Manutenção ativa. O último commit de openai-cli foi em 22 de out. de 2026.
- Para que posso usar openai-cli?
- Chamar modelos da OpenAI ou enviar arquivos pelo terminal durante o desenvolvimento ou a depuração. Criar scripts de fluxos de trabalho da API que processem a saída JSON em pipelines de shell ou jobs de CI. Gerar imagens pela linha de comando e salvá-las em uma pasta local. Executar consultas administrativas de uso de uma organização pelo terminal.
- Como instalar openai-cli?
- Instale com Homebrew: brew install openai/tools/openai Ou instale com Go (requer Go 1.26 ou posterior): go install 'github.com/openai/openai-cli/cmd/openai@latest' Defina sua chave de API no ambiente: export OPENAI_API_KEY="sk-..." Faça uma primeira solicitação, por exemplo, criando uma resposta: openai responses create --input "Say this is a test" --model gpt-5.5
- Onde consigo openai-cli?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/openai/openai-cli
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Ferramenta web e biblioteca Python que explicam comandos de shell associando cada argumento ao texto de ajuda correspondente na manpage.
Cliente de API HTTP para terminal, alternativa ao Postman e ao Insomnia, com requisições armazenadas em arquivos YAML simples.
Pacote declarativo em Go para criar ferramentas de linha de comando, com subcomandos, flags, conclusão no shell e geração de ajuda.
Framework de TUI para Go baseado na Elm Architecture, com layout compatível com Unicode, renderização inline ou em tela cheia e uma biblioteca de componentes.
Toolkit que gera interfaces de linha de comando nativas para agentes a partir de softwares existentes e oferece o registro CLI-Hub para instalar CLIs prontas.