Command line usage

AQG registers the Symfony console command a11y:scan.

vendor/bin/typo3 a11y:scan --root-pid=1

Options

--root-pid

Type: int

Root page UID of the subtree to scan. Either --root-pid or --page-uid must be given.

--page-uid

Type: int

Scan a single page by UID.

--depth

Type: int
Default: 99

Maximum page tree depth for a subtree scan.

--language

Type: string
Default: all

sys_language_uid to scan, or all for every language.

--changed-only

Type: flag

Process only content that changed since the last scan. Uses the stored source state in tx_a11y_source_state.

Examples

# Scan a subtree
vendor/bin/typo3 a11y:scan --root-pid=1

# Scan a single page
vendor/bin/typo3 a11y:scan --page-uid=42

# Incremental rescan of changed content only
vendor/bin/typo3 a11y:scan --root-pid=1 --changed-only

# Scan one language of a subtree
vendor/bin/typo3 a11y:scan --root-pid=1 --language=1

# Limit the depth of the subtree scan
vendor/bin/typo3 a11y:scan --root-pid=1 --depth=3

The command exits with a non-zero status when neither --root-pid nor --page-uid is supplied.

Tip

Run a full scan after deployments and content imports, and a --changed-only scan on a shorter interval. The quality gate evaluates stored findings, so the more current the data is, the more useful the gate becomes.