CI/CD & editors

Audityxe integrations

How do I add Audityxe to my CI/CD pipeline?

Run npx --yes audityxe-cli <url> --min-score 75 as a step in any CI that has Node.js 18.17+ — the step fails automatically when the score is below the threshold — or use the dedicated GitHub Action, which also comments the results on pull requests.

Audityxe audits a deployed URL, so in CI point it at a staging or preview environment. Each snippet below runs the free audityxe-cli and exits non-zero when the score is under the threshold.

GitHub Actions (dedicated action)

name: Website audit
on:
  pull_request:
permissions:
  contents: read
  pull-requests: write
jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - uses: zelvior/audityxe@main
        with:
          url: https://staging.example.com
          min-score: "75"
          comment-on-pr: "true"

Inputs: url, min-score, deep, compare-url, psi-key, comment-on-pr. Outputs: overall-score, result-file.

GitLab CI

website-audit:
  image: node:20
  script:
    - npx --yes audityxe-cli https://staging.example.com --min-score 75

Jenkins (declarative pipeline)

pipeline {
  agent { docker { image 'node:20' } }
  stages {
    stage('Website audit') {
      steps {
        sh 'npx --yes audityxe-cli https://staging.example.com --min-score 75'
      }
    }
  }
}

CircleCI

version: 2.1
jobs:
  website-audit:
    docker:
      - image: cimg/node:20.11
    steps:
      - run: npx --yes audityxe-cli https://staging.example.com --min-score 75
workflows:
  audit:
    jobs:
      - website-audit

Bitbucket Pipelines

image: node:20
pipelines:
  default:
    - step:
        name: Website audit
        script:
          - npx --yes audityxe-cli https://staging.example.com --min-score 75

Azure DevOps Pipelines

trigger: none
pool:
  vmImage: ubuntu-latest
steps:
  - task: NodeTool@0
    inputs:
      versionSpec: "20.x"
  - script: npx --yes audityxe-cli https://staging.example.com --min-score 75
    displayName: Website audit

Docker (public Node image — no Audityxe image exists)

docker run --rm node:20 npx --yes audityxe-cli https://example.com --min-score 75

Kubernetes CronJob (public Node image)

apiVersion: batch/v1
kind: CronJob
metadata:
  name: audityxe-nightly
spec:
  schedule: "0 3 * * *"
  jobTemplate:
    spec:
      template:
        spec:
          restartPolicy: Never
          containers:
            - name: audit
              image: node:20
              command: ["npx", "--yes", "audityxe-cli", "https://example.com", "--min-score", "75"]

VS Code extension

A prebuilt .vsix is included in the repository's vscode-extension folder for local install (Extensions → ⋯ → Install from VSIX). Commands: Audityxe: Audit a URL, Audit a URL (Deep crawl), Compare Two URLs, and View Score History. It is not on the Visual Studio Marketplace yet.

Frequently asked questions

Is there an Audityxe GitHub Action?

Yes. Use zelvior/audityxe@main in a workflow to audit a URL, fail the job below a minimum score, and post or update a pull-request comment. It is not on the GitHub Marketplace yet.

Does Audityxe have plugins for GitLab CI, Jenkins, CircleCI, Bitbucket, or Azure DevOps?

There are no dedicated plugins, orbs, or tasks. Any of these CI systems can run it as a plain command — npx --yes audityxe-cli <url> --min-score N — on a Node.js 18.17+ image, and the non-zero exit code fails the step.

Is there an official Audityxe Docker image or Helm chart?

No. Run the npm CLI inside the public node image (docker run --rm node:20 npx --yes audityxe-cli <url>), or from a Kubernetes CronJob that uses that image.

Is the Audityxe VS Code extension on the Marketplace?

Not yet. A prebuilt .vsix ships in the repository for local install, and Marketplace publication is on the roadmap. It adds commands to audit a URL, run a deep crawl, compare two URLs, and view score history.

Can Audityxe send Slack alerts or create Jira issues?

No. There are no webhooks, Slack, or Jira integrations. The GitHub Action can comment on pull requests, and the CLI's --json output can be piped into your own notification step.

Last reviewed 2026-10-01 against the Audityxe source code. Product names mentioned are trademarks of their respective owners; Audityxe is not affiliated with them.