Oobee overview

What Oobee is

Oobee is an automated accessibility testing tool that scans web pages against the Web Content Accessibility Guidelines (WCAG) and reports the issues it finds. It lets software development teams check whether their digital services are usable by persons with disabilities (PWDs) before and after release.

Oobee opens each page in a real browser, runs the axe-core accessibility engine plus Oobee’s own checks, and groups the results into Must Fix, Good to Fix and Needs Review. The Oobee command-line interface (CLI) and the @govtechsg/oobee npm module are built and maintained by the Government Technology Agency of Singapore (GovTech). The Oobee Desktop application is a separate product with a graphical interface.

Who is Oobee for?

Audience	What you use Oobee for
Developers and testers	Scan a site, sitemap or local file and read the report to find and fix accessibility issues
Teams with automated tests	Add accessibility checks to Playwright or Cypress tests and fail a build on issue thresholds
CI/CD maintainers	Run scheduled or per-commit scans from a pipeline and store the reports as build artefacts
Operators	Run Oobee behind a proxy, in Docker, with Safe Browsing or with Amazon S3 upload
Contributors	Build, test and change the Oobee engine

Key capabilities

Capability	Description
Five scan types	Scan a website by following links, a sitemap, an intelligent combination of both, a custom user flow, or local files
Device emulation	Scan as a desktop, a mobile device, a named Playwright device or a custom viewport width
Rule coverage	Check WCAG 2.x Level A and AA rules by default, with optional Level AAA rules and Oobee’s own checks
PDF scanning	Check PDF files with VeraPDF when you include them in a scan
Multiple report formats	Produce an interactive HTML report, a PDF summary, CSV files and optional compressed JSON files
Test framework integration	Use the npm module from Playwright, Cypress or any Node.js script
Controlled network access	Route scans through an HTTP, HTTPS or SOCKS5 proxy, and optionally block unsafe sites with Safe Browsing or family DNS
Cloud result upload	Upload the results folder to an Amazon S3 bucket after a scan

Documentation

I want to…	Start here
Run my first scan	Get started with Oobee
Install Oobee on my machine	Install the portable Oobee
Scan a site, sitemap or set of files	Run a scan
Add accessibility checks to my Playwright tests	Integrate Oobee with Playwright
Run Oobee in a CI/CD pipeline	Run Oobee in CI/CD
Understand what the scanner does and why pages are skipped	How Oobee scans
Look up command-line options and environment variables	CLI options, environment variables and error codes
Fix a failed or incomplete scan	Troubleshooting
Change the Oobee engine	Oobee architecture

Get Oobee

Download Oobee only from the official links. Other sources may pose risks to your system.

Product	Download
Oobee CLI (this documentation)	Oobee CLI
Oobee Desktop	Oobee Desktop

Get started with Oobee