CLI リファレンス
aqua CLI(aqua-cli)は、認証、プロジェクトセットアップ、テスト実行、ブラウザ記録のためのコマンドを提供します。すべてのコマンドは npx @aquaqa/cli で実行できます。
aqua-cli login
Section titled “aqua-cli login”aqua-cli login [--server-url <url>] [--force]aqua サーバーに対して認証を行います。デフォルトブラウザが開き、認証フローが完了します。成功すると、認証情報が ~/.aqua/credentials.json に保存されます。
| オプション | 説明 |
|---|---|
--server-url <url> | 認証先の aqua サーバー URL です。セルフホスト環境の場合に指定します。デフォルトは https://app.aquaqa.com です。 |
--force | 有効な認証情報が既に存在する場合でも再認証を行います。 |
aqua-cli logout
Section titled “aqua-cli logout”aqua-cli logout保存済み認証情報を削除します。
aqua-cli init
Section titled “aqua-cli init”aqua-cli init [--server-url <url>]プロジェクトの設定を初期化します。git リモート URL を検出して project_key を導出し、組織とプロジェクトを選択した上で、カレントディレクトリに .aqua/config.json ファイルを作成します。
| オプション | 説明 |
|---|---|
--server-url <url> | このプロジェクトに関連付ける aqua サーバーの URL です。セルフホスト環境の場合に指定します。デフォルトは https://app.aquaqa.com です。 |
aqua-cli whoami
Section titled “aqua-cli whoami”aqua-cli whoami現在認証されているユーザーの情報(ユーザー ID、メールアドレス、表示名)を表示します。
aqua-cli execute
Section titled “aqua-cli execute”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 | 変数の値をオーバーライドします。複数回指定できます。 |
aqua-cli record
Section titled “aqua-cli record”aqua-cli record [url]Playwright codegen を使用してブラウザ操作を記録します。インタラクティブなブラウザウィンドウが開き、操作がキャプチャされます。ブラウザを閉じると、記録された操作が BrowserStep[] JSON 配列として出力されます。
| オプション | 説明 |
|---|---|
[url] | (省略可) ブラウザが開いた際に遷移する URL です。 |
aqua-cli web
Section titled “aqua-cli web”aqua-cli webデフォルトブラウザで aqua の Web UI を開きます。
aqua-cli mcp-server
Section titled “aqua-cli mcp-server”aqua-cli mcp-serverMCP(Model Context Protocol)サーバーを起動します。これにより、Claude Code、Gemini CLI、OpenCode、Cursor などの AI エージェントが aqua とプログラム的にやり取りできるようになります。
サーバー URL は以下の優先順位で解決されます:
AQUA_SERVER_URL環境変数- カレントプロジェクトの
.aqua/config.json https://app.aquaqa.com(デフォルト)