Axe DevTools CLIの使い方

始める前に、 Axe DevTools CLIをインストールをご覧ください。

Axe DevTools CLIは axe コマンドで実行されます。このガイドでは最も一般的な3つのタスクを紹介します。

ウェブページの分析

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

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、セクション508、およびカスタムルールセット