Axe DevTools CLIの使い方

始める前に、Axe DevTools CLIをインストール。

Axe DevTools CLIはaxeコマンドを通じて動作します。このガイドでは、最も一般的な3つのタスクをカバーします。

ウェブページの分析

1つ以上のURLを直接axeコマンドに渡します。デフォルトでは、CLIはFirefoxを使用し、WCAG 2.1 AAルールセットを実行し、結果をstdoutに出力します。

axe https://example.com/

複数のページを一度に分析します：

axe https://example.com/ https://example.com/about.html

結果を後で使用するためにJSONファイルとして保存します：

axe https://example.com/ --save=./axe-results.json

直接HTMLレポートを生成します：

axe https://example.com/ --report=./axe-reports/

全オプションについては、ページの分析を参照してください。

仕様ファイルを使用したページの分析

シングルページアプリのナビゲーション、ログイン、ダイアログの解除、またはワークフローの複数ポイントでのページ分析のような複雑なシナリオには、axe specコマンドを使って仕様ファイルを使用してください。

仕様ファイル（JSONまたはYAML）は、分析するページのリストと分析前に各ページで行うアクションを定義します。最小限の例（axe-workflow.yaml）：

projects:
  - name: example
    id: example
    pageList:
      - name: Homepage
        url: https://example.com/
      - name: Search Results
        url: https://example.com/
        actions:
          - type "axe" into element "#searchform input"
          - click element "#searchform button[type=submit]"
          - wait for element ".search-results" to be found
          - analyze

仕様ファイルと結果の出力先ディレクトリを指定して、axe specで実行します。

axe spec ./axe-workflow.yaml ./axe-results

仕様ファイルの構造、アクション、およびオプションの詳細リファレンスについては、仕様ファイルを使用したページの分析を参照してください。

保存された結果からレポートを生成する

axe reporterコマンドを使用して、保存したJSON結果をHTML、JUnit XML、またはCSVに変換します。

axe reporter ./axe-results --format=html

JUnit XMLレポートを生成します（CIパイプラインで便利です）：

axe reporter ./axe-results --format=junit

CSVレポートを生成します：

axe reporter ./axe-results --format=csv

フィルタリングやその他のオプションについては、レポートの生成を参照してください。

次のステップ

• ページの分析：個々のページを分析するためのすべてのオプション
• 仕様ファイルを使用したページの分析：仕様ファイル、アクション、およびバッチ処理
• レポートの生成：レポート形式、フィルタリング、およびJSON結果の構造
• Axe Reportsに送信：Axe Reportsサービスへの結果のアップロード
• Axe Developer Hubに送信：Axe Developer Hubとの結果の統合
• 設定：ブラウザの選択、タイムアウト、永続的な設定
• カスタムルールセット：WCAG 2.x、Section 508、およびカスタムルールセット