コンテンツにスキップ

CLI リファレンス

aqua CLI(aqua-cli)は、認証、プロジェクトセットアップ、テスト実行、ブラウザ記録のためのコマンドを提供します。すべてのコマンドは npx @aquaqa/cli で実行できます。

Terminal window
aqua-cli login [--server-url <url>] [--force]

aqua サーバーに対して認証を行います。デフォルトブラウザが開き、認証フローが完了します。成功すると、認証情報が ~/.aqua/credentials.json に保存されます。

オプション説明
--server-url <url>認証先の aqua サーバー URL です。セルフホスト環境の場合に指定します。デフォルトは https://app.aquaqa.com です。
--force有効な認証情報が既に存在する場合でも再認証を行います。
Terminal window
aqua-cli logout

保存済み認証情報を削除します。

Terminal window
aqua-cli init [--server-url <url>]

プロジェクトの設定を初期化します。git リモート URL を検出して project_key を導出し、組織とプロジェクトを選択した上で、カレントディレクトリに .aqua/config.json ファイルを作成します。

オプション説明
--server-url <url>このプロジェクトに関連付ける aqua サーバーの URL です。セルフホスト環境の場合に指定します。デフォルトは https://app.aquaqa.com です。
Terminal window
aqua-cli whoami

現在認証されているユーザーの情報(ユーザー ID、メールアドレス、表示名)を表示します。

Terminal window
aqua-cli execute <qa_plan_id> [--env <name>] [--plan-version <n>] [--var key=value]

MCP サーバーを経由せずに、コマンドラインから直接 QA プランを実行します。

オプション説明
<qa_plan_id>(必須) 実行する QA プランの ID です。
--env <name>.aqua/environments/<name>.json から環境変数を読み込みます。
--plan-version <n>特定のプランバージョンを実行します。デフォルトは最新バージョンです。
--var key=value変数の値をオーバーライドします。複数回指定できます。
Terminal window
aqua-cli record [url]

Playwright codegen を使用してブラウザ操作を記録します。インタラクティブなブラウザウィンドウが開き、操作がキャプチャされます。ブラウザを閉じると、記録された操作が BrowserStep[] JSON 配列として出力されます。

オプション説明
[url](省略可) ブラウザが開いた際に遷移する URL です。
Terminal window
aqua-cli web

デフォルトブラウザで aqua の Web UI を開きます。

Terminal window
aqua-cli mcp-server

MCP(Model Context Protocol)サーバーを起動します。これにより、Claude Code、Gemini CLI、OpenCode、Cursor などの AI エージェントが aqua とプログラム的にやり取りできるようになります。

サーバー URL は以下の優先順位で解決されます:

  1. AQUA_SERVER_URL 環境変数
  2. カレントプロジェクトの .aqua/config.json
  3. https://app.aquaqa.com(デフォルト)