# Axe Core

You can include accessibility tests within your WebdriverIO test suite using the open-source accessibility tools [from Deque called Axe](https://www.deque.com/axe/). The setup is very easy, all you need to do is to install the WebdriverIO Axe adapter via:

* npm
* Yarn
* pnpm
* Bun

```
npm install -g @axe-core/webdriverio
```

```
yarn global add @axe-core/webdriverio
```

```
pnpm add -g @axe-core/webdriverio
```

```
bun add --global @axe-core/webdriverio
```

The Axe adapter can be used either in [standalone or testrunner](/docs/setuptypes.md) mode by simply importing and initializing it with the [browser object](/docs/api/browser.md), e.g.:

```
import { browser } from '@wdio/globals'
import AxeBuilder from '@axe-core/webdriverio'

describe('Accessibility Test', () => {
    it('should get the accessibility results from a page', async () => {
        const builder = new AxeBuilder({ client: browser })

        await browser.url('https://testingbot.com')
        const result = await builder.analyze()
        console.log('Acessibility Results:', result)
    })
})
```

You can find more documentation on the Axe WebdriverIO adapter [on GitHub](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/webdriverio#usage).
