← 返回命令列表

Linux command

gh-a11y 命令

文本

复制后可按需替换文件名、目录或参数。

常用示例

Run accessibility audit

gh a11y audit [url]

Audit current repository

gh a11y audit

Generate report

gh a11y audit --output [report.json]

Check specific page

gh a11y audit [url] --rules [wcag2a]

说明

gh a11y is a GitHub CLI extension for accessibility testing. It analyzes web pages and applications for WCAG compliance, identifying accessibility issues that may affect users with disabilities. The extension integrates with GitHub workflows, allowing accessibility checks to be part of pull request reviews and CI/CD pipelines. It generates reports in various formats for documentation and tracking. gh a11y helps teams maintain accessible web applications throughout development.

参数

audit
Run accessibility audit on a URL or repository.
--output _FILE_
Output file for report.
--rules _RULESET_
WCAG ruleset to apply (wcag2a, wcag2aa).
--format _FORMAT_
Output format (json, csv, html).
--help
Display help information.

FAQ

What is the gh-a11y command used for?

gh a11y is a GitHub CLI extension for accessibility testing. It analyzes web pages and applications for WCAG compliance, identifying accessibility issues that may affect users with disabilities. The extension integrates with GitHub workflows, allowing accessibility checks to be part of pull request reviews and CI/CD pipelines. It generates reports in various formats for documentation and tracking. gh a11y helps teams maintain accessible web applications throughout development.

How do I run a basic gh-a11y example?

Run `gh a11y audit [url]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.

What does audit do in gh-a11y?

Run accessibility audit on a URL or repository.