Rust无障碍检测工具a11ywatch_cli的使用，a11ywatch_cli提供高效网站可访问性检查和合规性测试

安装

1. 通过cargo安装：

cargo install a11ywatch_cli

可选功能：

• 如果使用Lite模式，可以添加grpc功能标志来编译protoc和tonic
• 需要安装Protoc进行编译
• 可以通过dist-vendor功能标志在安装时使用vendoring OpenSSL

Linux系统要求

在Ubuntu上需要OpenSSL：

apt-get update && apt upgrade -y && apt-get install -y --no-install-recommends build-essential gcc cmake libc6 libssl-dev pkg-config

Windows系统要求

需要安装Cmake。

构建

获取CLI的几种方式：

# 通过cargo安装
cargo install a11ywatch_cli
# 或通过npm安装
npm i a11ywatch-cli -g

初始化构建：

a11ywatch build

启动

启动实例的命令（需要Docker运行）：

# 基本启动
a11ywatch start

# 启动并附带前端（默认端口3270）
a11ywatch start -f

# 本地启动（使用nodejs单机模式）
a11ywatch start --local

# 在Docker中使用单机模式
a11ywatch start --standalone

# 升级实例
a11ywatch start --upgrade

操作示例

# 扫描URL并将结果输出到文件
a11ywatch scan --url https://a11ywatch.com > results.json

# 扫描URL并尝试修复代码
a11ywatch scan --url https://a11ywatch.com --fix

# 扫描并将结果保存为CSV
a11ywatch scan --save --csv --url https://a11ywatch.com

# 多页面扫描网站
a11ywatch crawl --url https://a11ywatch.com > results.json

# 多页面扫描包含子域名
a11ywatch crawl --url https://a11ywatch.com -S > results.json

# 多页面扫描包含子域名和所有TLD扩展
a11ywatch crawl --url https://a11ywatch.com -S -t > results.json

# 多页面扫描并以检查清单形式输出结果
a11ywatch crawl --url https://a11ywatch.com -d -n -s && a11ywatch --results-parsed-list

# 爬取并将结果保存为CSV
a11ywatch crawl --save --csv --url https://a11ywatch.com

环境变量配置

可以配置以下环境变量增强系统功能：

.env文件示例：

COMPUTER_VISION_SUBSCRIPTION_KEY="REPLACE_WITH_KEY"
COMPUTER_VISION_ENDPOINT="REPLACE_WITH_ENDPOINT"
PAGESPEED_API_KEY="REPLACE_WITH_PAGESPEED_API_KEY"
# 设置为目录或true以启用Litemode中的录制
PAGEMIND_RECORD=

也可以通过CLI配置设置：

# 配置计算机视觉凭证
a11ywatch --set-cv-token $mycv_token
a11ywatch --set-cv-url https://$myvcvname.cognitiveservices.azure.com/
a11ywatch --set-recording ./recordings

帮助提示

• 如果在Docker容器中运行本地网站，需要使用计算机主机名而不是localhost
• 停止服务时需要传递与构建/启动实例时相同的标志

完整示例代码

// 这是一个使用a11ywatch_cli进行网站可访问性检查的完整示例

fn main() {
    // 安装a11ywatch_cli (如果尚未安装)
    // std::process::Command::new("cargo")
    //     .arg("install")
    //     .arg("a11ywatch_cli")
    //     .status()
    //     .expect("Failed to install a11ywatch_cli");

    // 构建实例
    std::process::Command::new("a11ywatch")
        .arg("build")
        .status()
        .expect("Failed to build a11ywatch instance");

    // 启动实例
    std::process::Command::new("a11ywatch")
        .arg("start")
        .status()
        .expect("Failed to start a11ywatch instance");

    // 扫描网站并保存结果为JSON
    let output = std::process::Command::new("a11ywatch")
        .arg("scan")
        .arg("--url")
        .arg("https://example.com")
        .output()
        .expect("Failed to scan website");

    // 处理扫描结果
    if output.status.success() {
        let results = String::from_utf8_lossy(&output.stdout);
        println!("扫描结果: {}", results);
        
        // 可以进一步解析JSON结果
        // let parsed: Value = serde_json::from_str(&results).unwrap();
    } else {
        eprintln!("扫描失败: {}", String::from_utf8_lossy(&output.stderr));
    }

    // 多页面扫描网站
    let crawl_output = std::process::Command::new("a11ywatch")
        .arg("crawl")
        .arg("--url")
        .arg("https://example.com")
        .arg("--save")
        .arg("--csv")
        .output()
        .expect("Failed to crawl website");

    if crawl_output.status.success() {
        println!("多页面扫描完成，结果已保存为CSV");
    }
}

支持架构

Mac、Linux和Windows系统。

功能

• grpc - 使用gRPC连接到Litemode实例