CLIリファレンス

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

すべてのAxe DevTools CLIサブコマンドに関するコマンド構文と完全なオプションリファレンス

Not for use with personal data

すべてのAxe DevTools CLIサブコマンドとそのオプションのクイックリファレンス。使用ガイダンスと例については、各コマンドの記事へのリンクをたどってください。

  • axe <url> — URLでページを分析する
  • axe bulk-reports — 結果をAxeレポートに送信する
  • axe bulk-spec — スペックファイルのディレクトリを実行する
  • axe config-selenium — 永続的なブラウザデフォルトを設定する
  • axe devhub — 結果をAxe Developer Hubに送信する
  • axe licenses — 依存関係のライセンスを表示する
  • axe reporter — JSON結果からレポートを生成する
  • axe ruleset — カスタムルールセットを生成する
  • axe spec — スペックファイルを実行する

axe <url>

アクセシビリティの問題について1つ以上のウェブページを分析します。完全なドキュメントについてはTesting Pagesを参照してください。

axe <url...> [options]

一部のオプションは設定ファイルに保存され、CLI実行間で持続します。詳細については設定を参照してください。

オプション 説明
-a, --axe-source <path> 代替axe.jsファイルへのパス。
--accept-untrusted 信頼されていないSSL証明書を受け入れます。持続します。
--axe-devhub-api-key <api-key> Axe Developer HubのAPIキー。
--axe-devhub-project-id <project-id> Axe Developer HubのプロジェクトID。
--axe-devhub-server-url <url> Axe Developer HubサーバーのURL。デフォルト: https://axe.deque.com。
--axe-reports-api-key <api-key> Axe ReportsのAPIキー。
--axe-reports-dimensions <dimensions> Axe Reportsでこのスキャンをタグ付けするためのカンマ区切りのJTBDディメンション。
--axe-reports-url <url> Axe Reportsに結果を送信するためのURL。
--browser [name] 使用するブラウザ。対応するWebDriverが必要です。有効な値: firefox（デフォルト）、chrome、safari、edge、ie。継続されます。
--chrome-options [options] ChromeDriverに渡されるカンマ区切りのChromeコマンドラインスイッチ。持続します。
--chrome-path <path> Chromeブラウザ実行可能ファイルへの絶対パス。
--chromedriver-path <path> ChromeDriver実行可能ファイルへの絶対パス。
-c, --custom <path> デフォルトを上書きするカスタムルールセットファイルへのパス。
-d, --dir <path> JSON結果が保存されるディレクトリ。
-l, --disable <list> 無効にするカンマ区切りのルールID。
-e, --exclude <list> テストから除外する要素のためのカンマ区切りCSSセレクタ。
-q, --exit 違反が見つかった場合、コード1で終了します。
--enable-tracking <state> 使用データをメトリクスライブラリに送信することを有効(true)または無効(false)にします。継続されます。
-f, --format <value> レポート形式: html、junit、csv、universal、または+で区切られた組み合わせ。デフォルト: html。-r, --reportが必要です。
--filter <list> 含める結果タイプをカンマで区切ります: passes、violations、incomplete、inapplicable。--format csvが必要です。
--universal-best-practices --format universalを使用しているときにメタデータにbestPracticesEnabled=trueを記録します。
--universal-ruleset <id> --format universalを使用しているときにメタデータに記録するルールセットID。有効な値: wcag2、wcag2.1、wcag2.2、wcag2aaa、wcag2.1aaa、wcag2.2aaa、508、en301549、ttv5、rgaav4。デフォルト: wcag2.1。
--headless ブラウザをヘッドレスモードで起動します。永続化します。
-i, --include <list> カンマ区切りのCSSセレクタ。マッチした要素のみがテストされます。
--load-delay <n> ページ読み込み後に監査を実行する前に待機するミリ秒。デフォルト: 0。
--no-git-data Git ブランチおよびコミットデータを Axe Developer Hub に送信しません。
--no-reporter 違反の概要出力を抑制します。
--page-timeout <ms> ページの読み込みを待機する最大ミリ秒。デフォルト: 60000。継続されます。
--post-analyze-pause <ms> 分析後、次のアクション前に待機するミリ秒。デフォルト: 2000。継続されます。
--post-get-pause <ms> ページの読み込み後、スキャンする前に待機するミリ秒。デフォルト: 2000。継続されます。
--post-script-pause <ms> スクリプトアクションの後、スキャンする前に待機するミリ秒。デフォルト: 2000。継続されます。
-r, --report <output-dir> フォーマットされたレポートが書き込まれるディレクトリ。-f, --formatと共に使用してください。
--remote-proxy [proxy-server] トラフィックをリモートプロキシ経由でルーティングします（ChromeDriver のみ）。永続化します。
--remote-server [server-url] リモート WebDriver サーバーに接続します（例：Selenium Grid、BrowserStack）。永続化します。
--rules <list> 実行するカンマ区切りのルールID。指定されたルールのみがチェックされます。
-s, --save [filename] 結果をJSONファイルとして保存します。ファイル名はデフォルトでaxe-result.jsonです。
--script-timeout <ms> ワークフロースクリプトを待機する最大ミリ秒。デフォルト: 60000。継続されます。
--send-axe-reports 解析結果を Axe Reports に送信します。
--set-distinct-id <id> 使用状況追跡用の固有 ID を上書きします。永続化します。
--set-tracking-url <url> メトリクスデータが送信されるURLを上書きします。永続化されます。
--show-errors エラー時に完全なエラースタックトレースを表示します。
-j, --stdout JSON形式の結果を標準出力に出力します。他のすべての出力を消音します。
-t, --tags <list> 実行するルールをフィルタリングするためのカンマ区切りのタグ。
--timer 各テスト実行後に時間計測を表示します。
-v, --verbose ツール名、バージョン、および環境メタデータを出力に含めます。
-V, --version バージョン番号を出力します。
--window-size <width,height> ブラウザウィンドウのサイズをピクセル単位で設定します。永続化されます。

axe bulk-reports

JSON結果をAxeレポートに送信します。完全なドキュメントについてはAxe Reportsに送信を参照してください。

axe bulk-reports <results-directory> [options]
オプション 説明
--axe-reports-api-key <api-key> Axe ReportsのAPIキー。
--axe-reports-dimensions <dimensions> Axe Reportsでこのスキャンをタグ付けするためのカンマ区切りのJTBDディメンション。
--axe-reports-url <url> Axe Reportsに結果を送信するためのURL。
--send-axe-reports 解析結果を Axe Reports に送信します。
--verbose 詳細なログを有効にする。

axe bulk-spec

スペックファイルのディレクトリを一度に処理します。完全なドキュメントについてはワークフロー仕様を参照してください。

axe bulk-spec <spec-files-directory> [output-directory] [options]
オプション 説明
-a, --axe-source <path> 代替axe.jsファイルへのパス。
--accept-untrusted 信頼されていないSSL証明書を受け入れます。持続します。
--browser [name] 使用するブラウザ。対応するWebDriverが必要です。有効な値: firefox（デフォルト）、chrome、safari、edge、ie。継続されます。
-c, --custom <path> デフォルトを上書きするカスタムルールセットファイルへのパス。
--dismiss-alerts スキャンする前にブラウザのalert()、confirm()、prompt()ダイアログを解消します。
--enable-tracking <state> 使用データをメトリクスライブラリに送信することを有効(true)または無効(false)にします。継続されます。
-f, --format [value] レポート形式: html、junit、csv、または+で区切られた組み合わせ。デフォルト: html。
--headless ブラウザをヘッドレスモードで起動します。永続化します。
--no-analyze 各ページのアクションリストでanalyzeアクションの要件を削除します。
--no-html HTML レポートの生成を防ぎます。
--no-reports すべてのレポートファイルの生成を防ぎます。
--no-wait ワークフローアクション間の自動ポーズを無効にします。
--page-timeout <ms> ページの読み込みを待機する最大ミリ秒。デフォルト: 60000。継続されます。
--post-analyze-pause <ms> 分析後、次のアクション前に待機するミリ秒。デフォルト: 2000。継続されます。
--post-get-pause <ms> ページの読み込み後、スキャンする前に待機するミリ秒。デフォルト: 2000。継続されます。
--post-script-pause <ms> スクリプトアクションの後、スキャンする前に待機するミリ秒。デフォルト: 2000。継続されます。
--remote-proxy [proxy-server] トラフィックをリモートプロキシ経由でルーティングします（ChromeDriver のみ）。永続化します。
--remote-server [server-url] リモート WebDriver サーバーに接続します（例：Selenium Grid、BrowserStack）。永続化します。
--script-timeout <ms> ワークフロースクリプトを待機する最大ミリ秒。デフォルト: 60000。継続されます。
--set-distinct-id <id> 使用状況追跡用の固有 ID を上書きします。永続化します。
--set-tracking-url <url> メトリクスデータが送信されるURLを上書きします。永続化されます。
-t, --tags [list] 実行するルールをフィルタリングするためのカンマ区切りのタグ。
--user-agent <agent> カスタムユーザーエージェント文字列を設定します。永続化されます。
--validate スペックファイルを実行せずに検証します。
--wait-network-idle-new-connections [number] ネットワークがアイドルと見なされる前に必要な新しい接続の閾値。
--wait-network-idle-open-connections [number] ネットワークがアイドルと見なされる前に必要なオープン接続の閾値。
--wait-network-idle-timeout [ms] ネットワークがアイドルになるまで待機する最大ミリ秒数。
--window-size <width,height> ブラウザウィンドウのサイズをピクセル単位で設定します。永続化されます。

axe config-selenium

永続的なブラウザとタイミングのデフォルトを対話的に設定します。完全なドキュメントについては設定を参照してください。

axe config-selenium [options]
オプション 説明
-s, --show インタラクティブなプロンプトに入らずに現在の保存された設定を表示します。

axe devhub

JSON結果をAxe Developer Hubに送信します。完全なドキュメントについてはAxe Developer Hubに送信を参照してください。

axe devhub <results-directory|file> [options]
オプション 説明
--axe-devhub-api-key <api-key> Axe Developer HubのAPIキー。AXE_DEVHUB_API_KEY環境変数を上書きします。
--axe-devhub-project-id <project-id> Axe Developer HubのプロジェクトID。
--axe-devhub-server-url <url> Axe Developer HubサーバーのURL。デフォルト: https://axe.deque.com。
--no-git-data Git ブランチおよびコミットデータを Axe Developer Hub に送信しません。

axe licenses

すべてのCLI依存関係のオープンソースライセンスを表示および保存します。

axe licenses [options]

axe reporter

JSON結果をHTML、JUnit XML、またはCSVレポートに変換します。完全なドキュメントについてはレポート生成を参照してください。

axe reporter <results-dir> [dest-dir] [options]
オプション 説明
-b, --browser [name] 結果ディレクトリに複数のブラウザからの結果が含まれている場合、一つのブラウザの結果のみからレポートを生成します。
-d, --dest [path] 生成されたレポートの出力ディレクトリ。第2の位置引数としても指定可能です。
--filter <list> 含める結果タイプをカンマで区切ります: passes、violations、incomplete、inapplicable。--format csvが必要です。
-f, --format [type(s)] 出力形式: html、junit、csv、universal、または組み合わせ。デフォルト: html。
--universal-best-practices --format universalを使用しているときにメタデータにbestPracticesEnabled=trueを記録します。
--universal-ruleset <id> --format universalを使用しているときにメタデータに記録するルールセットID。有効な値: wcag2、wcag2.1、wcag2.2、wcag2aaa、wcag2.1aaa、wcag2.2aaa、508、en301549、ttv5、rgaav4。デフォルト: wcag2.1。

axe ruleset

カスタムルールセットファイルを生成します。完全なドキュメントはカスタムルールセットを参照してください。

axe ruleset [options]
オプション 説明
--508 [filename] セクション508ルール用の標準構成を生成します。
--all [filename] すべての対応ガイドライン用の標準構成を生成します。
-a, --axe-source <path> カスタムaxeソースへのパス。
-c, --custom [dir] changes.jsonファイルを含むディレクトリからカスタムルールセットを生成します。
-d, --destination [dir] 出力ディレクトリ。デフォルト: 現在の作業ディレクトリ。
-x, --disable-other-rules rulesプロパティに含まれないすべてのルールを無効にします。デフォルト: true。
--en301549 [filename] EN 301 549ルール用の標準構成を生成します。
-f, --format [format] 出力形式。
-l, --log 生成されたルールセットに含まれるすべてのルールのリストも生成します。
--only-changes ルールセットの変更と追加のみを生成します。
--rgaav4 [filename] RGAA v4ルール用の標準構成を生成します。
-t, --tags [list] 標準ルールセットをフィルタリングするためのカンマ区切りのタグ。
--ttv5 [filename] トラステッド テスター v5用の標準構成を生成します。
--wcag2 [filename] WCAG 2.0 AAルール用の標準構成を生成します。
--wcag21 [filename] WCAG 2.1 AAルール用の標準構成を生成します。
--wcag21aaa [filename] WCAG 2.1 AAAルール用の標準構成を生成します。
--wcag22 [filename] WCAG 2.2 AAルール用の標準構成を生成します。
--wcag22aaa [filename] WCAG 2.2 AAAルール用の標準構成を生成します。
--wcag2aaa [filename] WCAG 2.0 AAAルール用の標準構成を生成します。

axe spec

JSONまたはYAML仕様ファイルで定義されたページを分析します。完全なドキュメントはワークフロー仕様を参照してください。

axe spec <spec-file> [output-directory] [options]
オプション 説明
-a, --axe-source <path> 代替axe.jsファイルへのパス。
--accept-untrusted 信頼されていないSSL証明書を受け入れます。持続します。
--axe-devhub-api-key <api-key> Axe Developer HubのAPIキー。
--axe-devhub-project-id <project-id> Axe Developer HubのプロジェクトID。
--axe-devhub-server-url <url> Axe Developer HubサーバーのURL。デフォルト: https://axe.deque.com。
--axe-reports-api-key <api-key> Axe ReportsのAPIキー。
--axe-reports-dimensions <dimensions> Axe Reportsでこのスキャンをタグ付けするためのカンマ区切りのJTBDディメンション。
--axe-reports-url <url> Axe Reportsに結果を送信するためのURL。
--browser [name] 使用するブラウザ。対応するWebDriverが必要です。有効な値: firefox（デフォルト）、chrome、safari、edge、ie。保持されます。
--chrome-options [options] ChromeDriverに渡されるカンマ区切りのChromeコマンドラインスイッチ。持続します。
-c, --custom <path> デフォルトを上書きするカスタムルールセットファイルへのパス。
--descendant-links 各ページのリンクを収集し、結果に追加します。--verboseが必要です。
--dismiss-alerts スキャン前にブラウザのalert()、confirm()、prompt()ダイアログを解消します。
--download-path <path> ブラウザがダウンロードを保存する場所を設定します（Chrome のみ）。
--enable-tracking <state> 使用データをメトリクスライブラリに送信するのを有効（true）または無効（false）にします。保持されます。
-f, --format [value] レポート形式: html、junit、csv、universal、または+で区切った組み合わせ。デフォルト: html。
--filter <list> 含める結果の形式をカンマ区切りで指定: passes、violations、incomplete、inapplicable。--format csvが必要です。
--headless ブラウザをヘッドレスモードで起動します。永続化します。
--interactive-mode インタラクティブモードを使用するページで CLI の実行を許可します（Chrome のみ）。
--no-analyze 各ページのアクションリストにanalyzeアクションを必要としなくします。
--no-exit 違反が見つかった場合でも終了コード0を強制します。
--no-git-data Git ブランチおよびコミットデータを Axe Developer Hub に送信しません。
--no-html HTML レポートの生成を防ぎます。
--no-reports すべてのレポートファイルの生成を防ぎます。
--no-wait ワークフローアクション間の自動ポーズを無効にします。
--page-name <name> 指定された名前のページのみをスペックファイルから実行します。
--page-source スキャン済みのHTMLソースを結果に追加します。--verboseが必要です。
--page-timeout <ms> ページの読み込みを待つ最大ミリ秒数。デフォルト: 60000。保持されます。
--page-title ページタイトルを結果に追加します。--verboseが必要です。
--post-analyze-pause <ms> 分析後、次のアクションまで一時停止するミリ秒数。デフォルト: 2000。保持されます。
--post-get-pause <ms> ページロード後、スキャン前に一時停止するミリ秒数。デフォルト: 2000。保持されます。
--post-script-pause <ms> スクリプトアクション後、スキャン前に一時停止するミリ秒数。デフォルト: 2000。保持されます。
--remote-proxy [proxy-server] トラフィックをリモートプロキシ経由でルーティングします（ChromeDriver のみ）。永続化します。
--remote-server [server-url] リモート WebDriver サーバーに接続します（例：Selenium Grid、BrowserStack）。永続化します。
--resume-from <name> スペックファイル内で指定されたページより前のすべてのページをスキップします。
--scanned-url 基本URLとスキャンURLを詳細な結果に追加します。Chromeのみ。--verboseが必要です。
--script-timeout <ms> ワークフロースクリプトを待つ最大ミリ秒数。デフォルト: 60000。保持されます。
--send-axe-reports 解析結果を Axe Reports に送信します。
--set-distinct-id <id> 使用状況追跡用の固有 ID を上書きします。永続化します。
--set-legacy-mode レガシースキャンモードを有効にします。非推奨 — v5.0 で削除される予定です。
--set-tracking-url <url> メトリクスデータが送信されるURLを上書きします。永続化されます。
--silent-mode すべての装飾的な出力を抑制します。--verboseもアクティブな場合のみ結果が表示されます。
-t, --tags [list] 実行するルールをフィルタリングするためのカンマ区切りのタグ。
--universal-best-practices --format universalを使用する際にbestPracticesEnabled=trueをメタデータに記録します。
--universal-ruleset <id> --format universalを使用する際にメタデータに記録するルールセットID。有効な値: wcag2、wcag2.1、wcag2.2、wcag2aaa、wcag2.1aaa、wcag2.2aaa、508、en301549、ttv5、rgaav4。デフォルト: wcag2.1。
--user-agent <agent> カスタムユーザーエージェント文字列を設定します。永続化されます。
--validate 実行せずに仕様ファイルを検証します。
-v, --verbose ツール名、バージョン、および環境メタデータを出力に含めます。
--wait-network-idle-new-connections [number] ネットワークがアイドルと見なされる前に必要な新しい接続の閾値。
--wait-network-idle-open-connections [number] ネットワークがアイドルと見なされる前に必要なオープン接続の閾値。
--wait-network-idle-polling-every [ms] ネットワークアイドル検出のためのミリ秒単位のポーリング間隔。
--wait-network-idle-timeout [ms] ネットワークがアイドルになるまで待機する最大ミリ秒数。
--window-size <width,height> ブラウザウィンドウのサイズをピクセル単位で設定します。永続化されます。

Is this page helpful?

Help us improve this page

Still need help?