You are viewing the documentation for a prerelease version. View Latest

Installation

pip install nvda-addon-testkit

Configure

[tool.nvda-testkit]
addon-bundle = "dist/my-addon-*.nvda-addon"
nvda-channel = "stable"

Run in GitHub Actions

jobs:
  e2e:
    runs-on: windows-2025
    steps:
      - uses: actions/checkout@v5
      - uses: zirekhq/nvda-addon-testkit@v1
        with:
          nvda-channel: stable
      - run: scons dist
      - run: pytest tests_e2e/ -v

The action requires a Windows runner — pick whichever one matches what your users run. This repository’s own e2e test suite runs on both windows-2025 and windows-2022 (the latter for Windows 10 22H2, including builds still on Extended Security Updates).

Want to help? Learn how to contribute to the ZirekHQ docs ›