Apidog CLI：ターミナルで動作するAPIクライアント

APIワークスペースはGUIに存在し、日々の作業はターミナルで行われます。これら2つの間のコンテキスト切り替えには、常に数秒の時間と集中力が失われ、CIパイプラインやAIエージェントのセッションでは、GUIは選択肢にすらなりません。Apidog CLIはそのギャップを埋めます。Apidog CLIは、Apidogプラットフォーム全体（テスト、エンドポイント、スキーマ、環境、モックの期待値、ドキュメント）を、すでに開いているシェルプロンプトに持ち込みます。

まず、正直な定義から始めましょう。Apidog CLIは、別のcurlではありません。もし単発のGETリクエストを発行してJSONを目視確認したいのであれば、curlやHTTPieがすでにその役割を十分に果たしており、ターミナルおよびTUI RESTクライアントのまとめ記事では、対話的な側面がカバーされています。Apidog CLIは、APIワークスペースそのもののクライアントです。構築したテストシナリオを実行し、API契約を読み書きし、プロジェクト内外で仕様を移動させることができ、これらすべてをスクリプトやエージェントが呼び出せるコマンドから行います。

ここでの「ターミナルに存在する」の意味

ターミナルのHTTPツールは一度に1つのリクエストを処理します。Apidog CLIはプロジェクトレベルで動作します。そのコマンドサーフェスは40以上のグループに及び、それらは5つのジョブに分類されます。

すべてのコマンドは`--help`をサポートし、出力は構造化されたJSONであり、ほとんどの応答には`agentHints.nextSteps`が含まれており、次何を実行すべきか（あなたまたはエージェントに）示します。最後のこの詳細は小さなことのように聞こえますが、ツールの感触を大きく変えます。CLIは、ユーザーがすべてを記憶していると仮定するのではなく、ワークフローをガイドします。

1つのコマンドでインストール

CLIはnpmパッケージ（apidog-cli）として提供され、macOS、Linux、Windowsで動作します。Node.js 16以降が必要です。

npm install -g apidog-cli
apidog --version

次に、APIアクセストークンでサインインします。Apidogアプリから取得してください。アバターをクリックし、「アカウント設定」を開き、「APIアクセストークン」の下にあるトークンをコピーします。

apidog login --with-token <YOUR_TOKEN>

トークンは`~/.apidog/config.toml`に保存されるため、リポジトリやログには含めないでください。CIでは、代わりにシークレットから`--access-token`を使用して実行ごとに渡します。4つのグローバルフラグがほとんどのコンテキストをカバーします。`--project`はプロジェクトを選択し、`--branch`はブランチを選択し、`--access-token`は保存されたログインを上書きし、`--api-base-url`はCLIをセルフホストされたApidogデプロイメントに向けます。Apidog CLI認証ガイドでは、CI用のトークンについて詳しく説明しています。

視覚的に構築したテストを実行する

これがCLIが構築されたワークフローです。Apidogのビジュアルエディターでテストシナリオを作成します。連鎖するリクエスト、ある応答から抽出されて次の応答に注入される変数、ステータスやボディに対するアサーションなどです。そして、シェルが存在する場所ならどこでもそれを実行できます。

# Copy this command, IDs included, from the scenario's CI/CD tab
apidog run -t <scenario_id> -e <env_id> -r cli

このコマンドは、すべてのアサーションが成功すると`0`で終了し、何か失敗すると非ゼロで終了するため、パイプラインは余計な連携なしにそれに依存できます。`-e`を切り替えることで、同じシナリオを開発、ステージング、または本番環境に向けられます。CSVまたはJSONファイルを渡すと、シナリオを各行に対して繰り返し実行します。これがデータ駆動型テストがステップを重複させることなく機能する方法です。もしゼロから始める場合は、REST APIのステップバイステップチュートリアルがインストールから最初の成功実行までを案内します。

レポートは4つの形式で出力されます。`cli`は段階的な結果をターミナルに表示し、`html`、`json`、`junit`はダッシュボードやCIアーティファクトとして`apidog-reports/`に出力されます。`-r cli,junit`のように自由に組み合わせてください。テストレポートガイドでは、各形式がどのように見えるかを示しています。

お使いのラップトップに依存しない実行の場合、`runner`および`scheduled-task`コマンドは、セルフホスト型ランナーと時間指定実行を管理します。これはApidogにおけるスケジュール済みAPIテストの背後にあるのと同じメカニズムです。

アプリを開かずにAPI契約を管理する

これは他のターミナルテストツールにはない部分です。テストを実行するのと同じCLIで、API定義自体を読み書きできます。

apidog endpoint list --project <project_id>
apidog schema get <schema_id>
apidog environment list
apidog mock list

エンドポイント、データスキーマ、フォルダ、環境、変数、セキュリティスキーム、再利用可能なコンポーネントはすべて照会および編集可能です。`mock`コマンドは、モックサーバーが返す固定のリクエストとレスポンスのペアであるモックの期待値を管理します。`doc`および`docs-site`コマンドは公開されたドキュメントに触れます。WebSocketとSocket.IOエンドポイントには独自のグループがあり、`database-connection`はテストシナリオが読み取るデータベース設定をカバーします。

インポートおよびエクスポートは、重要なフォーマットに対応しています。OpenAPI 3.xとSwagger 2.0（ほとんどのツールチェーンが標準とする仕様）、そしてPostmanコレクションです。これにより、CLIは移行スクリプトにおける橋渡し役となります。あるシステムから仕様を取り出し、Apidogにプッシュし、全体の交換をバージョン管理できます。

apidog import openapi.json --project <project_id>
apidog export --format openapi

AIエージェントが駆動できるように構築

CLIの2026年リリースは、1つのアイデアに強く傾倒しています。それは、AIコーディングエージェントが人間と同じくらい安全にAPIワークスペースを操作できるようになるべきだということです。これを実現するために4つの要素があります。

まず、構造化された出力です。すべてのコマンドはエージェントが解析できるJSONを返し、`agentHints.nextSteps`は、エラーからの回復方法を含め、各結果の後に何をすべきかを指示します。

次に、公開された入力スキーマです。`apidog cli-schema list`と`apidog cli-schema get`は、すべての書き込みコマンドが期待する正確なJSON形式を公開し、`apidog cli-schema validate`は、プロジェクトに触れる前にペイロードをチェックします。安全な書き込みの儀式は常に同じです。スキーマを取得し、JSONを生成し、それを検証してから、`create`または`update`を実行します。

3つ目は、パッケージ化されたスキルです。`skill`コマンドは、CLIの操作知識をエージェントが直接ロードできる形式で提供します。これがApidog CLIスキルを構築した理由の背景にあるストーリーです。我々の測定では、CLIスキーマを通じて作業するエージェントは、ペイロードを推測するエージェントよりも約30%少ないツール呼び出しと25%少ないトークンを使用しました。詳細な数値はこちらの分析で説明されています。

4つ目は、パーミッションゲートです。デフォルトでは、人間が「外部AI編集権限」（Apidogクライアント2.8.32以降のプロジェクト設定、機能設定、AI機能設定内）を有効にするまで、AIをソースとするブランチへの書き込みはブロックされます。もう一つの選択肢はAIブランチです。これはエージェントが必要なリソースをインポートし、編集を行い、その結果をレビューのためのマージリクエストとして返す隔離されたブランチです。触れられていないAIブランチは24時間後に自動アーカイブされるため、実験が積み重なることはありません。エージェントが最初のドラフトを作成した場合でも、API契約はレビュー可能な状態に保たれます。

Apidog CLIがそうではないもの

正直な情報に基づいてツールを選択する方が、後でギャップを発見するよりも優れているため、3つの制限を明確に述べます。

これは対話型のリクエストクライアントではありません。アドホックなPOSTを入力して応答を整形出力するようなコマンドはありません。curl、HTTPie、およびTUIクライアントがその役割を担っており、それらの方が得意です。

これはオープンソースではありません。パッケージはプロプライエタリであり、npmが唯一のインストールチャネルであり、`--help`を超える操作を行うにはApidogアカウントが必要です。無料ティアはここで説明されている完全なワークフローをカバーしていますが、監査可能なライセンスが厳格な要件である場合、オープンソースのランナーが正直な推奨です。

これはスタンドアロンではありません。CLIはプラットフォームのターミナル部分です。シナリオ、エンドポイント、環境はローカルファイルではなく、Apidogプロジェクト内に存在します。それが、設計、テスト、モック、ドキュメント全体で単一の信頼できる情報源を得るためのトレードオフです。

ターミナルツールボックスにおける位置付け

他のランナーとの違いは、オーサリングが行われる場所です。NewmanとPostman CLIはPostmanで作成されたコレクションを実行します。HurlとBrunoはテキストファイルとして作成されたテストを実行します。Apidog CLIは、契約、モック、ドキュメントも保持するビジュアルエディターで作成されたシナリオを実行します。Apidog CLI vs Newmanの比較ではさらに深く掘り下げており、全分野は主要なターミナルベースAPIテストツールのまとめでランク付けされています。

ほとんどのチームにとって実用的な設定は次のとおりです。curlまたはxhを軽い確認のために手癖にしておき、`apidog run`でCIにおけるスイートを実行させます。GitHub Actionsウォークスルーには、コピー＆ペーストで始められるパイプラインが用意されています。

よくある質問

Apidog CLIは無料で使えますか？ はい、無料です。パッケージはnpmから無料でインストールでき、Apidogの無料ティアはシナリオの構築とCLIを通じた実行をカバーしています。有料プランではチーム規模の機能が追加され、基本的なCLIアクセスは含まれません。

curlやHTTPieの代わりになりますか？ いいえ、その意図もありません。それらのツールはアドホックなリクエストを送信しますが、Apidog CLIは保存されたテストシナリオを実行し、プロジェクトのリソースを管理します。ほとんどのターミナル環境では両方が使われることになるでしょう。

CIで完全にヘッドレスで実行できますか？ はい、できます。CIのシークレットから`--access-token`で認証し、シナリオIDを指定して`apidog run`を実行し、終了コードに基づいてビルドをゲートしてください。ランナー上にデスクトップアプリは必要ありません。

どのような形式をインポートおよびエクスポートできますか？ OpenAPI 3.x、Swagger 2.0、およびPostmanコレクションを双方向でサポートしています。これにより、インポートによる移行と、エクスポートによる統合の両方に対応できます。

AIエージェントはどのように安全に利用できますか？ スキーマ検証書き込みの儀式とパーミッションゲートを通じてです。`cli-schema validate`は、不正なペイロードが適用される前にそれを捕捉し、AIブランチは人間がマージするまでエージェントの編集を隔離します。Claude CodeでApidog CLIを使用する方法で、エージェント内でそれが機能している様子をご覧ください。

ターミナルは、すでにテストが実行され、エージェントが作業している場所です。そこにAPIクライアントも置くことで、最後のコンテキスト切り替えがなくなります。Apidogをダウンロードし、npmからCLIをインストールして、1つのシナリオをエンドツーエンドで実行してください。Apidog CLIページには、`run`コマンドを超えて進む準備ができたときの完全なコマンドリファレンスがあります。