Repolode
openai

openai/openai-cli

OpenAI REST API向けの公式CLI。モデル、Responses、ファイル、画像、管理者用エンドポイントのリソース別コマンドを提供します。

スター
767
フォーク
79
未解決の Issue
27
最終コミット
6 時間前

これは何?

openai-cliは、Goで実装されたOpenAI REST API向けの公式コマンドラインインターフェースです。リソースごとにコマンドが整理されており、`openai <resource> <command>` の形式で、Responsesの作成、ファイルのアップロードとダウンロード、画像の生成などを実行できます。通常のエンドポイントではAPIキーで認証し、管理者用エンドポイントでは別の管理者キーを使います。

APIを直接呼び出すだけでなく、CLIはデフォルトで読みやすいテキストを出力し、スクリプト向けにJSON、JSONL、YAML形式も利用できます。`--transform` フラグではGJSON構文を使ってフィールドを抽出でき、エラー出力も個別に整形または抽出できます。画像生成では結果をローカルディレクトリに保存し、そのパスを出力します。また、Bash、zsh、fish、PowerShellのシェル補完にも対応しています。

Homebrewまたは`go install`でインストールでき、カスタムベースURL、追加のリクエストヘッダー、相互TLSクライアント証明書にも対応しています。

主な機能

  • 01管理者用エンドポイントと専用キーを含む、OpenAI APIのリソース別コマンド。
  • 02デフォルトでは読みやすいテキストを出力し、スクリプト向けにJSON、JSONL、YAML形式も利用可能。
  • 03レスポンスやエラーからフィールドを抽出する、GJSONベースの`--transform`。
  • 04画像を生成してローカルに保存し、ファイルパスを出力。
  • 05シェル補完とコマンド入力中の候補表示。
  • 06カスタムベースURL、リクエストヘッダー、相互TLSクライアント証明書に対応。

ユースケース

  • 開発やデバッグ中に、ターミナルからOpenAIのモデルを呼び出したり、ファイルをアップロードしたりする。
  • シェルのパイプラインやCIジョブでJSON出力を解析するAPIワークフローをスクリプト化する。
  • コマンドラインから画像を生成し、ローカルフォルダーに保存する。
  • ターミナルから組織の管理者用利用状況クエリを実行する。

クイックスタート

  1. 1

    Homebrewでインストールする

    brew install openai/tools/openai
  2. 2

    またはGoでインストールする(Go 1.26以降が必要)

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

    環境変数にAPIキーを設定する

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

    最初のリクエストを実行する(例:responseを作成する)

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

使う前に知っておきたいこと

  • 標準のAPIコマンドにはOpenAI APIキーが必要です。利用料金が発生する場合があります。
  • GoでのインストールにはGo 1.26以降が必要です。

トピック

よくある質問

openai-cli とは?
OpenAI REST API向けの公式CLI。モデル、Responses、ファイル、画像、管理者用エンドポイントのリソース別コマンドを提供します。 openai-cliは、Goで実装されたOpenAI REST API向けの公式コマンドラインインターフェースです。リソースごとにコマンドが整理されており、`openai <resource> <command>` の形式で、Responsesの作成、ファイルのアップロードとダウンロード、画像の生成などを実行できます。通常のエンドポイントではAPIキーで認証し、管理者用エンドポイントでは別の管理者キーを使います。
openai-cli は無料で使えますか?ライセンスは?
openai-cli は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
openai-cli は今もメンテナンスされていますか?
活発にメンテナンス中。openai-cli の最終コミットは 2026年10月22日 です。
openai-cli は何に使えますか?
開発やデバッグ中に、ターミナルからOpenAIのモデルを呼び出したり、ファイルをアップロードしたりする。 シェルのパイプラインやCIジョブでJSON出力を解析するAPIワークフローをスクリプト化する。 コマンドラインから画像を生成し、ローカルフォルダーに保存する。 ターミナルから組織の管理者用利用状況クエリを実行する。
openai-cli のインストール方法は?
Homebrewでインストールする: brew install openai/tools/openai またはGoでインストールする(Go 1.26以降が必要): go install 'github.com/openai/openai-cli/cmd/openai@latest' 環境変数にAPIキーを設定する: export OPENAI_API_KEY="sk-..." 最初のリクエストを実行する(例:responseを作成する): openai responses create --input "Say this is a test" --model gpt-5.5
openai-cli はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/openai/openai-cli

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト