CLIを使用してアクセシビリティ結果をaxe Developer Hubに送信する
CLIを使用してアクセシビリティ結果をaxe Developer Hubにアップロードするさまざまな方法を説明します
CLIを使用すると、アクセシビリティ結果をaxe Developer Hubに送信できます。次のことができます。
- 結果をアップロードするを以前のテスト実行からaxe Developer Hubに送信します。このオプションは
devhubCLIサブコマンドを使用し、Web APIを使用したウェブページの分析や、以前のCLI実行（個別のページを分析したり、スぺックファイルを実行して結果を保存した場合）から結果をアップロードできます。 - 個別のページを分析するを分析し、結果を直接axe Developer Hubに送信します（まず結果ファイルを保存する必要はありません）。
- スペックファイルを実行するを実行し、結果を直接axe Developer Hubに送信します（まず結果ファイルを保存する必要はありません）。
要件
CLIをaxe Developer Hubで使用するには、次のものが必要です。
- axeアカウントとaxe Developer Hubのサブスクリプション。詳細についてはaxe Developer Hubを始めるを参照してください。
- An axe Developer Hub project where you upload results. See 新しいaxe Developer Hubプロジェクトを作成する for information about creating a new project. When you create a project, you specify that the project will use the CLI as its input or data source. You will need these values to upload results:
- あなたの個人APIキー（APIキーの下にあるaxeアカウントに表示されます）
- プロジェクトID（新しいaxe Developer Hubプロジェクトを作成したときに指示に表示されます）
- （オプション）web APIを使用するテストがある場合、テストを結果ファイルまたはファイルを生成するように修正する必要があります。結果ファイルは、テスト実行の結果を含む
.jsonファイルで、使用するAPIによって結果ファイルを作成する手順が異なります。詳細は結果ファイルの作成を参照してください。結果ファイルをアップロードするには、devhubサブコマンドを使用します。
結果をaxe Developer Hubに送信する
通常、CLIはウェブサイトをテストし、-sオプションを使用して結果を保存する場合にのみ結果を生成します（これはテストされたウェブサイトのアクセシビリティエラーに関する情報を含む.jsonファイルです）。CLIは、--axe-devhub-api-keyコマンドラインオプション（またはAXE_DEVHUB_API_KEY環境変数の設定）を使ってAPIキーをコマンドラインで指定し、--axe-devhub-project-id（またはAXE_DEVHUB_PROJECT_ID環境変数の設定）でプロジェクトIDを指定することで、結果をaxe Developer Hubに送信できます。
デフォルトでは、CLIを実行しているディレクトリがGitリポジトリの一部である場合、Git情報もアップロードします。Git情報のアップロードの仕組みについては、GitとGitlessモードを参照してください。
CLIは、現在のGitブランチとコミット履歴をアクセシビリティ結果に関連付けます。
Gitリポジトリ内のディレクトリからCLIを実行する場合、axe Developer Hubに送信される結果は同じコミット（そのSHAによって決定されます）の以前の結果を上書きします。（各コミットに関連付けられる結果セットは1つだけです。）CLIを実行するたびに新しいコミットを作成するか、--no-git-dataオプションを使用してGit結果の報告を控える必要があります。詳細はGitとGitlessモードを参照してください。
結果をアップロードする
以前にテストを実行し、結果ファイル（通常.jsonファイル名でaxe-result-2025-09-03T14 02 32-0700.jsonといった名前のもの）を持っている場合、これらの結果をdevhubサブコマンドを使用してaxe Developer Hubにアップロードできます。ページをテストするか、スペックファイルを実行する際に-sコマンドラインオプションを使用して結果を保存します。
axe https://example.com -sページ分析またはスペックファイルを実行する際には、最初に結果を保存し、それからアップロードする必要はありません。APIキーとプロジェクトIDを指定することで、CLIはページの分析が完了したとき、またはスペックファイルの実行が終了したときに結果をアップロードします。個別ページを分析するとスペックファイルを実行するを参照してください。
前の例では、結果ファイルを作成してから、次のようにaxe Developer Hubにアップロードできます。
axe devhub <results-dir(s)-or-file(s)> --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>.（ドット）をresults-dir(s)-or-file(s)として使用して、現在のディレクトリ内のすべての.json結果ファイルをアップロードできます。複数のディレクトリまたはファイルを指定してアップロードすることも可能です。
Web APIを使用して結果ファイルを作成する
Web APIを使用している場合、APIテストを修正して、CLIのdevhubサブコマンドを使用してaxe Developer Hubにアップロードできる結果ファイルを書く必要があります。結果ファイルを作成する際の情報については以下のリンクの表を参照してください。これらのAPIは、提供されているレポートまたはログAPIを使用して.jsonファイルとして結果をディスクに書き込みます。
| API | リンク名 |
|---|---|
| Node.js | axe DevTools Logger |
| C# | Reporter-Compatible JSONの作成 |
| Java | Javaでレポートを生成する |
| Python | Reporter-Compatible JSONの作成 |
| Ruby | レポートオプション |
個別ページを分析する
個々のウェブページをスキャンし、APIキーとプロジェクトIDを指定して、結果をaxe Developer Hubに送信できます。:
axe https://google.com --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>この例では、CLIがGoogleのサイトに対してアクセシビリティテストを実行し、指定されたプロジェクトIDで参照されるaxe Developer Hubプロジェクトに結果を送信します。
コマンドラインで複数のページを一覧表示してテストすることもできます。:
axe https://example.com/page1.html https://example.com/page2.html --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>結果を確認するには、axe Developer Hubのプロジェクトを訪問してください。アクセシビリティ問題の表示概要を参照してください。
スペックファイルを実行する
スペックファイルの実行結果を送信するには、--axe-devhub-api-keyおよび--axe-devhub-project-idコマンドラインオプションを使用できます。
axe spec my-spec-file.yml --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>この例では、YAMLスペックファイルmy-spec-file.ymlを実行し、そのアクセシビリティ結果をaxe Developer Hubにアップロードします。スペックファイルの詳細については、ワークフロースペックおよびワークフローアクションを参照してください。
ページのテストをスキップしてスペックファイルを先に進める必要がある場合は、--resume-from <page>コマンドラインオプションを使用して、スペックファイル内の特定のページからテストを再開できます。詳細については、から再開するを参照してください。
GitモードとGitlessモード
デフォルトでは、axe Developer Hubは、Gitリポジトリ内のディレクトリからCLIを実行した場合、現在のブランチの最新のGitコミットにあなたのアクセシビリティ結果を関連付けます。これにより、アクセシビリティエラーをGitコミットに簡単に結び付けることができます。しかし、この動作の副作用として、axe Developer Hubに結果を報告するたびに、新しい結果が他の実行結果を上書きします同じコミットで（そのSHAに基づいて）。さらに、別のブランチに切り替えると、そのブランチの最新のコミットに関連付けられた結果がaxe Developer Hubに送信されます。
axe Developer Hubのデフォルトの動作が望ましくない場合:
- Gitリポジトリ外のディレクトリでCLIを使用できます。
--no-git-dataコマンドラインオプションを使用することで、サーバーにGit情報を報告することを省略し、Gitlessモードで実行します。このモードでは、サーバーに結果を報告するたびに、新しいテストランが時間と日付によって識別され作成されます。Gitモードで実行する場合とは異なり、ブランチとコミットによって識別されません。
GitとGitlessの結果がaxe Developer Hubでどのように整理され提示されるかについては、プロジェクトのページおよびテストランページを参照してください。
コマンドラインオプション
CLIは以下のコマンドラインオプションを受け入れます。:
--axe-devhub-api-keyは個人用APIキーを設定でき、AXE_DEVHUB_API_KEY環境変数に相当します。必須--axe-devhub-project-idはあなたのaxe Developer HubプロジェクトのプロジェクトIDを設定し、AXE_DEVHUB_PROJECT_ID環境変数に相当します。必須--axe-devhub-server-urlはデフォルト以外のサーバーを使用することができ（https://axe.deque.com）、AXE_DEVHUB_SERVER_URL環境変数に相当します。あなたの組織が地域インスタンス、プライベートクラウド、またはオンプレミスでのAxe Developer Hubの展開を使用している場合はこれを設定してください。オプション--no-git-dataはサーバーへのGit情報の報告を回避します。詳細についてはGitモードとGitlessモードを参照してください。相当する環境変数はありません。オプション
環境変数
APIキー、プロジェクトID、またはサーバーURLをコマンドラインで指定する必要がないように環境変数を設定できます。特に連続統合でAPIキーを秘密にしておくことが推奨される時は、この方法を使用してください。
AXE_DEVHUB_API_KEYおよびAXE_DEVHUB_PROJECT_IDを設定することで、ページを分析したりスペックファイルを実行するたびに結果をaxe Developer Hubに常に送信します。たとえば、これらの環境変数を設定し、以下のようにページを分析する場合:
axe https://somewebsite.com結果はaxe Developer Hubに送信されます。この動作は、CLIを使用してページを分析するやスペックファイルを実行するを行うときに適用されます。
AXE_DEVHUB_API_KEYは個人用APIキーを指定し、--axe-devhub-api-keyコマンドラインオプションに相当します。AXE_DEVHUB_PROJECT_IDはあなたのaxe Developer HubプロジェクトのプロジェクトIDを指定し、--axe-devhub-project-idコマンドラインオプションに相当します。AXE_DEVHUB_SERVER_URLはAxe Developer HubのサーバーURLを指定し（デフォルトはhttps://axe.deque.com）、--axe-devhub-server-urlコマンドラインオプションに相当します。あなたの組織が地域インスタンス、プライベートクラウド、またはオンプレミスでのAxe Developer Hubの展開を使用している場合はこれを設定してください。