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>

1つ以上のウェブページをアクセシビリティ問題について分析します。詳しくは Testing Pages をご覧ください。

axe <url...> [options]

一部のオプションは設定ファイルに保存され、CLIの実行をまたいで保持されます。詳しくは Configuration をご覧ください。

オプション 説明
-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レポートのAPIキー。
--axe-reports-dimensions <dimensions> Axeレポートでこのスキャンをタグ付けするためのカンマ区切りのJTBDディメンション。
--axe-reports-url <url> Axeレポートに結果を送信するための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、または +による組み合わせ。デフォルト: html。必要: -r, --report。
--filter <list> 含めるカンマ区切りの結果タイプ: passes、 violations、 incomplete、 inapplicable。必要: --format csv。
--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 Reportsに送信します。詳しくは 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

1回の実行でスペックファイルのディレクトリを処理する。詳細については ワークフロー仕様 を参照してください。

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、または複数の組み合わせ。デフォルト: html。

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、または +-区切りの組み合わせ。デフォルト： 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] 実行するルールをフィルタリングするためのカンマ区切りのタグ。
--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?