{"id":13590829,"url":"https://github.com/microsoft/axe-windows","last_synced_at":"2026-01-14T05:52:58.422Z","repository":{"id":38807629,"uuid":"182308830","full_name":"microsoft/axe-windows","owner":"microsoft","description":"Automated accessibility testing engine for Windows applications","archived":false,"fork":false,"pushed_at":"2025-11-19T11:53:32.000Z","size":5315,"stargazers_count":156,"open_issues_count":6,"forks_count":60,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-12-27T07:33:16.609Z","etag":null,"topics":["accessibility-insights","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"Contributing.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-19T18:29:40.000Z","updated_at":"2025-12-13T00:55:32.000Z","dependencies_parsed_at":"2023-02-14T12:10:26.480Z","dependency_job_id":"717885d8-b57b-4546-b306-cec91dbfd0da","html_url":"https://github.com/microsoft/axe-windows","commit_stats":{"total_commits":718,"total_committers":30,"mean_commits":"23.933333333333334","dds":0.6239554317548747,"last_synced_commit":"e3f6368e7c987f7b21d9019705490300a9df972d"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"purl":"pkg:github/microsoft/axe-windows","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Faxe-windows","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Faxe-windows/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Faxe-windows/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Faxe-windows/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/axe-windows/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Faxe-windows/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28411920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T05:26:33.345Z","status":"ssl_error","status_checked_at":"2026-01-14T05:21:57.251Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility-insights","hacktoberfest"],"created_at":"2024-08-01T16:00:50.890Z","updated_at":"2026-01-14T05:52:58.415Z","avatar_url":"https://github.com/microsoft.png","language":"C#","readme":"\u003c!-- Copyright (c) Microsoft Corporation. All rights reserved.\r\n     Licensed under the MIT License. --\u003e\r\n\r\n## Overview\r\n\r\nAxe.Windows is a NuGet package for running automated accessibility tests on Windows® applications.\r\n\r\nTo get the latest version of the Axe.Windows NuGet package, visit\r\n[Axe.Windows on NuGet.org](https://www.nuget.org/packages/Axe.Windows/).\r\n\r\n### How to run automated accessibility tests\r\n\r\n1. Create a `Config` object using `Config.Builder`.\r\n\r\n        // Create config to specifically target a process\r\n        var myConfigBuilder = Config.Builder.ForProcessId(1234);\r\n\r\n        // Optional: configure to create an A11yTest file\r\n        myConfigBuilder.WithOutputFileFormat(OutputFileFormat.A11yTest);\r\n\r\n        // Optional: configure to output the file to a specific directory (otherwise, current directory will be used)\r\n        myConfigBuilder.WithOutputDirectory(\".\\test-directory\");\r\n\r\n        // Ready to use config\r\n        var myConfig = myConfigBuilder.Build();\r\n\r\n2. Create a `Scanner` object using the `ScannerFactory` object with the `Config`.\r\n\r\n        // Create scanner using myConfig\r\n        var scanner = ScannerFactory.CreateScanner(myConfig);\r\n\r\n3. Call  the `Scan` or `ScanAsync` method on the `Scanner` object, to scan synchronously or asynchronously respectively.\r\n\r\n        var scanOutput = scanner.Scan(null); // Synchronously scan with default options.\r\n\r\n4. Check the output.\r\n\r\n        Console.WriteLine(\"Number of errors found in scan of first top-level window: \" + scanOutput.WindowScanOutputs.First().ErrorCount);\r\n\r\n\r\n- Use an automation test framework like [UI Automation](https://docs.microsoft.com/en-us/dotnet/framework/ui-automation/ui-automation-overview) or [WinAppDriver](https://github.com/microsoft/WinAppDriver) to manipulate your application\r\n- Scan your application as many times as you need to\r\n- Axe.Windows returns results with each scan and can optionally save each scan's results to an a11ytest file you can open with [Accessibility Insights](https://accessibilityinsights.io/docs/en/windows/overview)\r\n\r\n\r\nFor more details and a complete code example, please visit the [automation reference page](./docs/AutomationReference.md)\r\n\r\n## Command line interface\r\n\r\nAxe.Windows also has a command line interface (CLI) to simplify automated testing in build pipelines. Please check out the\r\n[command line interface readme](./src/CLI/README.MD)\r\nfor more information.\r\n\r\n## Contributing\r\n\r\nAll contributions are welcome! Please read through our guidelines on [contributions](./Contributing.md) to this project.\r\n\r\nFor instructions on how to build the code, please visit [building the code](./docs/BuildingTheCode.md).\r\n\r\nFor an overview of the solution, please visit the [solution overview](./docs/solution.md).\r\n\r\n### More information\r\n\r\nVisit the [Overview of Axe.Windows](./docs/Overview.md) page.\r\n\r\n## Data/Telemetry\r\n\r\nAxe.Windows does not collect any telemetry on its own. However, the package does provide telemetric data for use by calling applications. \r\nPlease see the [Telemetry](./docs/Telemetry.md) page for more details.\r\n\r\n## Reporting security vulnerabilities\r\nIf you believe you have found a security vulnerability in this project, please follow [these steps](https://technet.microsoft.com/en-us/security/ff852094.aspx) to report it. For more information on how vulnerabilities are disclosed, see [Coordinated Vulnerability Disclosure](https://technet.microsoft.com/en-us/security/dn467923).\r\n\r\n## FAQ\r\nPlease visit our [FAQ section](./docs/FAQ.md) to get answers to common questions.\r\n","funding_links":[],"categories":["C#","C\\#"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Faxe-windows","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Faxe-windows","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Faxe-windows/lists"}