Skip toPage Navigation
Skip toMain Content
DequeDocsaxe DevTools® for Web
Contact UsContact Us

  • Navigation

  • Welcome
    • DevTools for Web Examples
    • Glossary
  • Overview
    • Use Cases
    • Rulesets
    • axe-core Versions
    • Needs Review vs Incomplete
  • axe DevTools Extension
    • User Flow Analysis
    • Scanning for Accessibility Issues
    • Configuration
    • Intelligent Guided Tests
      • Table
      • Keyboard
      • Modal Dialog
      • Interactive Elements
      • Lists
      • Images
      • Structure
      • Forms
    • Exporting
    • Sharing Results
    • Raising Manual Issues
    • Automatic Color Contrast Resolver
    • Remaining Testing
    • Offline Mode
    • Usage Data
    • Private Cloud
    • Release Notes
      • Version 4.96.1
      • Version 4.94.1
      • Version 4.92.0
      • Version 4.90.0
      • Version 4.86.0
      • Version 4.85.0
      • Version 4.84.3
      • Version 4.83.0
      • Version 4.82.0
      • Version 4.81.4
      • Version 4.81.3
      • Version 4.80.1
      • Version 4.79.3
      • Version 4.78.1
      • Version 4.77.1
      • Version 4.76.0
      • Version 4.74.1
      • Version 4.73.1
      • Version 4.72.0
      • Version 4.71.2
      • Version 4.71.1
      • Version 4.71.0
      • Version 4.70.0
      • Version 4.69.0
      • Version 4.68.1
      • Version 4.66.1
      • Version 4.65.0
      • Version 4.64.1
      • Version 4.63.1
      • Version 4.63.0
      • Version 4.62.0
      • Version 4.60.1
      • Version 4.59.2
      • Version 4.58.3
      • Version 4.57.3
      • Version 4.56.0
      • Version 4.55.0
      • Version 4.53.3
      • Version 4.52.0
      • Version 4.51.0
      • Version 4.50.0
      • Version 4.49.0
      • Version 4.47.0
      • Version 4.46.2
      • Version 4.45.0
      • Version 4.39.2
    • Additional Information
  • APIs and CLI
    • About axe DevTools APIs
    • The Usage Service
      • Overview
      • Getting Started
      • Environment Variables
      • Event Properties Reference
    • Downloading Resources
      • Set up your Nexus
      • Set up your Artifactory
    • Node.js and JavaScript
      • Browser JavaScript (@axe-devtools/browser)
        • Install
          • Install from Deque's Agora
          • Install from a Bundle
          • Import and Initialize
        • Write Tests
        • API References
      • Cypress (@axe-devtools/cypress)
        • Installation Options
        • Install from Deque's Agora
        • Write Tests
        • Generating Reports with Cypress
        • API Documentation
      • Playwright (@axe-devtools/playwright)
        • Install
          • Install from Deque's Agora
          • Import and Initialize
        • Write Tests
        • API Documentation
        • Playwright Error Handling
      • Puppeteer (@axe-devtools/puppeteer)
        • Install
          • Download Demo Project
          • Install from Deque's Agora
          • Install from a Bundle
          • Import and Initialize
        • Write Tests
        • API References
        • Puppeteer Error Handling
      • WebDriverIO (@axe-devtools/webdriverio)
        • Install
          • Download Demo Project
          • Install from Deque's Agora
          • Install from a Bundle
          • Import and Initialize
        • Write Tests
        • API Reference
        • WebDriverIO Error Handling
      • WebDriverJS (@axe-devtools/webdriverjs)
        • Install
          • Download Demo Project
          • Install from Deque's Agora
          • Install from a Bundle
          • Import and Initialize
        • Write Tests
        • API References
        • WebDriverJS Error Handling
      • Node.js Logger (@axe-devtools/logger)
        • Node Logger
        • Node Logger API Reference
      • Node.js Reporter (@axe-devtools/reporter)
        • Node Reporter
        • Node Reporter Code Examples
        • Node Reporter API Reference
      • Migrating to v4.X
      • Other Integrations
        • Cucumber JavaScript
        • Karma
    • C#
      • C# Installation
        • Install with Visual Studio
        • Install with .NET Core CLI
      • Configuring projects
      • Writing Tests
      • Generating Reports with C#
      • Migrating to v4.X
      • C# Error Handling
      • C# API Documentation
    • Java
      • Installing the Java Integrations
        • Download Demo Project
        • Install from a Bundle
        • Install from Deque's Agora
        • Import and Initialize
      • Using the Java Integrations
        • Write Tests with Cucumber
        • Write Tests with Hamcrest
        • Write Tests with Playwright
        • Write Tests with Selenium
        • Use the Results
        • Generating Reports with Java
      • Java Integrations API Reference
        • Java Hamcrest API
        • Java Playwright API
        • Java Selenium API
      • Migrating to v4.X
      • Java Troubleshooting
      • Java Playwright Troubleshooting
    • Python
      • Installing axe DevTools via pip
      • Installing axe DevTools via a bundle
      • Generating Reports with Python
      • Basic example using axe-devtools-api
      • axe-devtools-api API Reference
      • axe-devtools-selenium API Reference
      • axe-devtools-unittest API Reference
      • axe-devtools-robot API Reference
      • axe-devtools-behave API Reference
      • Python Error Handling
    • Ruby
      • Setting up Access
      • axe DevTools Capybara
      • axe DevTools Cucumber
      • axe DevTools RSpec
      • axe DevTools Selenium
      • axe DevTools Watir
      • Advanced API Usage with Ruby
      • axe DevTools Gems bundles
      • Ruby Error Handling
      • Migrating to v4.X
    • CLI
      • Install
        • Executables
        • Node.js
      • Quick Start Guides
        • Analyze a Web Page
        • Analyze a Workflow
        • Create reports
      • Configuration
      • Page tests
      • Workflow specs
      • Batch Processing of Spec Files
      • Reporting
        • Reporting with the CLI
        • Uploading to axe Reports
        • Creating and Filtering Reports
        • How JSON Results are Stored on Disk
      • The Usage Service
      • Workflow actions
      • Custom Rulesets
      • Migrating to v4.X
    • Customizing Rules
    • Release Notes
      • Overview
      • C#
      • CLI
      • Java
      • Node.js
      • Node.js Reporter
      • Python
      • Ruby
      • Previous Versions
        • Version 4.7
        • Version 4.6
        • Version 4.5
        • Version 4.4
        • Version 4.3
        • Version 4.2
        • Version 4.1
        • Version 4.0
  • Downloads
  • APIs and CLI
  • CLI
  • Quick Start Guides

Starting with axe DevTools CLI

Link to Starting with axe DevTools CLI copied to clipboard

Get started with axe DevTools CLI

Before getting started, make sure axe DevTools CLI is installed.

  • Analyze a web page
  • Analyze a workflow
  • Generate a report

Is this page helpful?

Help us improve this page

Still need help?

  • Visit the Help Center
  • Contact Us
Deque Docs
© 2024, Deque Systems, Inc. All Rights Reserved