ApiCatcher
ApiCatcher

CLI

文書バージョン: 20261024

macOS / Windows のデスクトップ版で使えます。iOS と Android にはこのコマンドはありません。使う前に ApiCatcher を開いてください。

CLI を使うと、AI は ApiCatcher にすでにある機能を呼び出せます。HTTP リクエストの検索と分析、スクリプトや書き換えルールの管理ができます。

コマンドの場所

システムのターミナルで実行します。macOS は「ターミナル」、Windows は「コマンド プロンプト」または PowerShell です。

macOS では、インストール済みアプリの中にコマンドがあります。

/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli tools

ApiCatcher が「アプリケーション」フォルダにないときは、/Applications/ApiCatcher.app を実際の ApiCatcher.app の場所に変えてください。

今開いているターミナルだけ短い名前を付けておくと、あとから apicatcher と入力できます。

alias apicatcher="/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli"

Windows では、ApiCatcher をインストールしたフォルダにある apicatcher-cli.exe を実行します。通常の場所は次のとおりです。

%LOCALAPPDATA%\Programs\ApiCatcher\apicatcher-cli.exe tools

デスクトップの ApiCatcher アイコンは画面を開くもので、このコマンドではありません。

これ以降の例は apicatcher と書いています。お使いのパソコンの実際のパスに読み替えてください。

アプリを開き、CLI を有効にする

CLI は初期状態ではオフで、ポートを使いません。コマンドを使うには次の順です。

  1. ApiCatcher を開く。
  2. サイドバーの CLI を開き、スイッチを入れる。
  3. アプリを完全に終了して、もう一度開く。この起動から、このパソコンでコマンドを受け付けます。

スイッチを切ったときも、止まるのは次の起動からです。

アプリが閉じている、スイッチがオフ、または切り替えたあと再起動していないときは失敗します。

コマンド

このバージョンのツールと引数を表示します。パラメータはこの出力を正とします。

apicatcher tools

ツールを 1 つ呼びます。--args は JSON オブジェクトです。

apicatcher call search_requests --args '{"host":"api.example.com","limit":10}'

標準入力からも渡せます。

printf '%s' '{"host":"api.example.com"}' | apicatcher call search_requests

--args がなく、標準入力が端末のときは引数は {} です。

apicatcher call get_capture_status

出力

標準出力は JSON オブジェクト 1 つです。成否は ok で分かります。ツール結果が JSON なら result に埋め込み、それ以外は文字列のままです。

{"ok":false,"error":"ApiCatcher is not running"}

search_requests の主な引数は keyword、search_target（url、host、req_header、resp_header、req_body、resp_body）、method、host、status_code、file_type、session_id、limit、skip です。

安全

  • コマンドはこのパソコンだけで使え、同じネットワークの他の機器からはつながりません。
  • 出力は実際のキャプチャで、Cookie やトークン、ボディを含むことがあります。公開の場所に貼らないでください。