Postman CLI

Postman CLIは、コーディングエージェント、ターミナル、CIでのAPI開発と検証を支えるツールです。Claude Code、Codex、Cursorなどのエージェントに、組織のAPIに関する情報を提供します。変更のたびにテスト、モックの作成、シミュレーション、負荷テストを行うための機能も備えています。Postman公式のデジタル署名付きコマンドラインツールで、Postmanデスクトップアプリに同梱されています。

Postmanのエージェント用スキルを通じて利用します。Postmanプラグインでエージェントにスキルを追加し、postman initでリポジトリにも同じスキルを追加します。チームでは、この2つを併用します。プラグインをインストールすると、エージェントはどのリポジトリでもスキルを利用できます。エージェントごとのインストール手順は次のとおりです。Claude Code：claude plugin marketplace add anthropics/claude-plugins-officialを実行し、続けてclaude plugin install postman@claude-plugins-officialを実行します。Codex：codex plugin marketplace add postmanlabs/postman-pluginを実行し、続けてcodex plugin add postman@postmanを実行します。Cursor：/add-plugin postmanと入力します。postman initは、リポジトリ内のpostman/skills/にスキルを保存し、AGENTS.mdにその参照先を記載します。そのリポジトリで作業するチームメンバーやCIジョブも、同じスキルを利用できます。リポジトリ内のスキルを最新の状態に保つには、postman skills statusを実行してください。

Postman CLIには、組織のAPIに関する情報を取得するためのコマンドが用意されています。postman context-graph ask：サービス間の依存関係について質問できます。postman workspace context：関連付けられたワークスペースの内容と、そこでの変更内容を確認できます。postman dependency addとpostman dependency install：他のチームが公開したコレクションやAPI仕様を取り込めます。postman describe：APIを利用するコードを書くために必要な詳細情報を取得できます。Context Graphへの問い合わせには、CLIでのサインインと、チームでのContext Graphの有効化が必要です。Context Graphは、Gitに接続されたPostmanワークスペースの情報に加え、チームがPostmanの［Home］＞［Agent Context］から接続したGitHubやNew Relicなどの情報源をもとに構築されます。

はい。postman performance runで、コレクションを使った負荷テストを実行できます。--peak-vuで仮想ユーザー数、--durationで実行時間を分単位で指定します。負荷プロファイルは、固定、ランプアップ、スパイク、ピークから選べます。--pass-ifでは、avg、p90、p95、p99、error_rate、rpsにしきい値を設定し、合格条件を定義できます。条件を満たさない場合は終了コード1が返り、CIジョブが失敗します。--runner postman-cloudを追加すると、Postmanのクラウドランナーから負荷を生成できます。

はい。エージェントがローカルで実行するコレクション、テスト、負荷テストを、CIでも同じように実行できます。テストが失敗すると0以外の終了コードが返るため、リリースを停止する条件として利用できます。認証にはPOSTMAN_API_KEYを使います。機械処理に適した形式で結果を出力するには、--jsonまたは--output ndjsonを指定します。コレクションの実行結果は、組み込みのCLI、JSON、JUnit、HTMLレポーターで出力できます。GitHubでは、Postman CLI GitHub Actionを使い、ワークフロー内でコレクションやモニターの実行、構文チェック、ガバナンスルールの検証を行えます。

ローカルで作業するだけなら、アカウントは必要ありません。postman initや、ローカルファイルを扱うコマンドは、アカウントなしで利用できます。Context Graphへの問い合わせ、検索、依存リソースの取得など、Postman Cloudにアクセスする操作には、サインインまたはAPIキーが必要です。サインインした状態で実行すると、実行結果もPostmanにアップロードされます。

いいえ。シークレットの値は、ブラウザーの一度限りの入力フォームから登録し、チームのShared Vaultに保存します。CLIに値が出力されることはありません。エージェントが参照できるのは、シークレットの名前だけです。

Postman CLIは、Postman公式のコマンドラインツールです。Newmanはコレクションの実行専用ツールで、対応する形式はv2.1のJSON形式のみです。Postman v12以降のv3コレクションは実行できません。Postman CLIは、Native Gitで必要なv3のYAML形式を含む、すべてのコレクション形式に対応しています。コレクションに加え、モニター、モックサーバー、フローも扱えます。Newmanから移行する場合は、postman collection migrateでv2.1コレクションを変換してください。詳しい手順は、NewmanからPostman CLIへの移行ガイドをご覧ください。

Postman CLIの一部のコマンドは、ご利用のプランによって利用可否が異なります。各プランで利用できる機能は、料金プランページで比較できます。