openai/openai-cli

Official CLI for the OpenAI API

何を解決するか

OpenAI REST API との対話に標準化された公式のコマンドラインインターフェース (CLI) を提供し、一般的な API タスクに対してカスタムスクリプトを書く必要や、直接 HTTP リクエストを使用する必要をなくします。

動作方法

このツールは、リソースベースのコマンド構造(openai [resource] <command> [flags])を使用して CLI コマンドを API エンドポイントにマッピングします。標準 API キー、管理者キー、および安全な通信のための相互 TLS (mTLS) など、さまざまな認証方法をサポートしています。特定の @ 構文を使用してファイルアップロードを処理し、JSON、YAML、読みやすいテキストなど、人間が読めるだけでなく機械でも解析可能な柔軟な出力形式を提供します。

対象ユーザー

OpenAI のモデルや管理者ツールをターミナルワークフロー、シェルスクリプト、または自動化パイプラインに統合したい開発者やシステム管理者。

主な特徴

  • リソースベースのコマンド: API リソースごとに整理されており、直感的なナビゲーションが可能。
  • 柔軟な出力: json、jsonl、yaml、text など複数のフォーマットをサポートし、他のツールにパイプしやすい。
  • セキュアな認証: API キー、管理者キー、およびベータ版の相互 TLS (mTLS) をサポート。
  • ファイル処理: @ 構文による簡易なファイル渡しと、テキストデータとバイナリデータを自動的に判別するファイルタイプスニッフィングを備える。
  • データ変換: API レスポンスから特定のデータを抽出・変換するための GJSON 構文を内蔵。
  • 統合された画像保存: 生成された画像をローカルディレクトリに自動保存し、プレビュー機能を提供。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト