Skip to main content
Version: v5

Introduction

AudioEye’s Accessibility Testing SDK helps you find accessibility issues earlier in development, before they reach production.

You can use the SDK in local development, staging, and CI/CD environments to test components, pages, and full user workflows. This makes it easier to catch issues close to the code that introduced them and fix them before they move downstream into QA or release.

Start here​

If you're new to the SDK, begin with getting started. That guide walks you through:

  • supported Node.js versions
  • retrieving your AudioEye entitlement token
  • configuring npm, yarn, or pnpm to install SDK packages
  • choosing the package that best fits your workflow
  • setting up installation in local development and CI/CD

Choose your onboarding path​

Every path starts with getting started to configure your entitlement token and package manager. After that, continue to the guide that best matches how your team already works:

  • Verify installation and run your first scan — CLI
  • Accessibility checks in component tests — Jest
  • Browser-based end-to-end tests and authenticated flows — Playwright or Cypress
  • Lower-level control or a custom test harness — Custom integrations

Fastest path for most teams: complete getting started, install the CLI, and run one successful scan. This validates authentication, installation, and SDK execution before you add framework-specific test code.

What you can test​

Depending on the package you choose, you can use the SDK to test:

  • individual components
  • rendered HTML fragments
  • full pages
  • deployed and internal URLs
  • authenticated application flows
  • local, staging, and CI/CD environments

After setup​

Once installation is complete, these guides will help you go deeper:

Interested in seeing the Accessibility Testing SDK in action? Contact us to learn more.