This package sets up your environment for screen reader automation.
It enables automation for VoiceOver on macOS and NVDA on Windows.
Run this command:
npx @guidepup/setupAnd get cracking with your screen reader automation code!
If you are using GitHub Actions, check out the dedicated guidepup/setup-action:
- name: Setup Environment
uses: guidepup/setup-actionIf you are running this command locally you may need to take some manual steps to complete setup by following the manual VoiceOver setup documentation.
If you are running this command in CI/CD, it is recommended to add the --ci flag to prevent interactive prompts:
npx @guidepup/setup --ciIf updating the TCC.db is not possible (due to enabled SIP) or not required, you can skip the database update step by using the --macos-ignore-tcc-db flag:
npx @guidepup/setup --macos-ignore-tcc-dbNote
If the necessary permissions have not been granted by other means, using this flag may result in your environment not being set up for reliable screen reader automation.
If you are encountering errors in CI for macOS you can pass a --macos-record flag to the command which will output a screen-recording of the setup to a ./recordings/ directory:
npx @guidepup/setup --ci --macos-recordIf you are using a proxy connection, you must define the proxy URL in an env variable. You can use any of the following variables:
HTTPS_PROXYhttps_proxyHTTP_PROXYhttp_proxy
Check out some of the other Guidepup modules:
@guidepup/guidepup- Reliable automation for your screen reader a11y workflows through JavaScript supporting VoiceOver and NVDA.@guidepup/playwright- Seamless integration of Guidepup with Playwright.@guidepup/virtual-screen-reader- Reliable unit testing for your screen reader a11y workflows.@guidepup/jest- Jest matchers for reliable unit testing of your screen reader a11y workflows.