The primary command for initiating local accessibility scans. It recursively scans the TYPO3 page tree starting from a defined PID and evaluates TYPO3 content records against the configured ruleset. Remote frontend crawler scans are started from the AQG backend module and require a valid PRO, Agency or Trial licence.
Bash
./vendor/bin/typo3 a11y:scan --root-pid=1Parameter Reference
| Parameter | Description | Example |
|---|---|---|
| --root-pid | Starting point ID for the crawler in the page tree. | --root-pid=12 |
| --depth | Maximum recursion depth. 0 scans only the root PID. | --depth=3 |
| --site | Site identifier to scan. | --site=my-site |
| --mode | Scan mode: full or changed-only. | --mode=changed-only |
| --language | Language UID to scan. | --language=0 |
Use exit codes to detect whether the scan finished successfully. Accessibility issues may still exist even when the command exits with code 0.
| Code | Meaning | Action Recommendation |
|---|---|---|
| 0 | Scan completed successfully. Issues may still exist. | Review the scan results in TYPO3 or in your logs. |
| 1 | Scan failed because of a configuration error or exception. | Check TYPO3 logs and your command configuration. |
CI Integration
For GitHub Actions, GitLab CI, or Jenkins, trigger the command as part of your validation stage and keep the console output or related logs for later review.