@userway/cicd-cli

@userway/cicd-cli is a component of UserWay CI/CD (Continuous Accessibility) infrastructure

It is a command line interface (CLI) tool intended to run by developers on their local machines and by DevOps (CI/CD) pipeline infrastructure. It glues UserWay CI/CD E2E integrations and UserWay CI/CD backend. The main function is to collect a11y reports generated during CI/CD pipeline execution and to trigger analysis via UserWay CI/CD API.

Install @userway/cicd-cli npm package

npm install --save-dev @userway/cicd-cli

In order for UserWay CI/CD CLI to function properly there are 2 prerequisites: register at https://cicd.userway.org and import your repository as a project create userway.config.js file

Configuration of userway.config.js depends on a use case. There are 3 distinct use cases of UserWay CI/CD CLI:

• self hosted accessibility scans
• managed accessibility scans
• combination of the two - into a single use-case

userway.config.js for self-hosted use case

Once you have installed @userway/cicd-cli package, you will need to create the config file:

/** @type {import('@userway/cicd-cli').schema.Config} */
module.exports = {
   organization: 'YOUR-OURGANIZATION-SLUG',
   project: 'YOUR-OURGANIZATION-NAME,
   connection: 'https://google.com',
   pages: [
       { url: '/' }
   ]
};

Run @userway/cicd-cli

npx userway -token YOUR-TOKEN-FROM-CICD-USERWAY-ORG

Check out our sample repository ↗ for a working example

** Prerequisites Node.js v16.20.2 or higher is required