Get Started

There are three primary ways to run the solution. Pick the one that matches how you work, then follow its guide.

I want to… Use the… Guide
Run one-off or scripted jobs from my terminal Command-line interface CLI Guide
Embed audit/remediation into my own Python app Python API API Integration Guide
Process documents automatically as they land in S3, at scale Deployable pipeline Deployable Pipeline Guide

Prefer to click through a demo UI instead? See the Streamlit Guide under Reference.

Fastest path to a first result

If you just want to see it work, install and run the CLI against an HTML file β€” no S3 or BDA setup required for the audit path:

pip install content-accessibility-utility-on-aws
content-accessibility-utility-on-aws audit -i page.html -o report.html -f html
open report.html   # a human-readable accessibility report

Then dive into the CLI Guide for the full workflow (convert β†’ audit β†’ remediate), or jump straight to the Quickstart.


Table of contents