Accessibility Conformance Report for GitHub CLI

(Based on VPAT® Version 2.4)

Report Date

This report was last updated on June 18, 2024.

Product Description

GitHub CLI, or gh, is a command-line interface to GitHub for use in your terminal or your scripts.

Contact Information

Please share questions or comments on the accessibility community discussion page.

Scope

The scope of this report includes the following commands in the GitHub CLI application:

  • gh cache list
  • gh pr diff
  • gh pr lock
  • gh pr comment
  • gh pr review
  • gh pr merge
  • gh pr ready
  • gh pr view
  • gh pr checks
  • gh pr create
  • gh extension browser
  • gh extension search
  • gh extension create

  • gh extension list

  • gh repo archive
  • gh repo fork
  • gh repo view
  • gh repo list
  • gh code space view
  • gh code space list
  • gh code space delete
  • gh code space jupyter
  • gh code space logs
  • gh code space code
  • gh code space rebuilt
  • gh code space ports
  • gh code spaces create
  • gh project view
  • gh project close
  • gh project create
  • gh project copy
  • gh project mark-template

  • gh project item-list

  • gh gist clone
  • gh formatting
  • gh reference

  • gh environment

  • gh auth login
  • gh auth token

  • gh auth status

  • gh search code
  • gh variable set
  • gh config clear-cache

Evaluation Methods Used

Scenarios were tested using:

  • Keyboard-only interactions
  • JAWS and NVDA with Google Chrome
  • axe
  • Colour Contrast Analyzer
  • Platform features such as high contrast and zoom

Applicable Standards/Guidelines

This report reflects outstanding issues found by an audit based on the level A and AA criteria of the Web Content Accessibility Guidelines version 2.1 (WCAG 2.1 AA).

Terms

  • Supports: The functionality of the product has at least one method that meets the criterion without known defects or meets with equivalent facilitation.
  • Partially Supports: Some functionality of the product does not meet the criterion.
  • Does Not Support: The majority of product functionality does not meet the criterion.
  • Not Applicable: The criterion is not relevant to the product.
  • Not Evaluated: The product has not been evaluated against the criterion.

WCAG 2.1

Level A Success Criteria

Success Criteria Conformance Level Remarks and Explanations
1.1.1 Non-text Content

Partially Supports

Exceptions include:

  • Terminal animation on cli.github.com has no text alternative
1.2.1 Audio-only and Video-only (Prerecorded)

Supports
1.2.2 Captions (Prerecorded)

Supports
1.2.3 Audio Description or Media Alternative

Supports
1.3.1 Info and Relationships

Partially Supports

Exceptions include:

  • [GitHubCLI1.30] [GitHub CLI Basic Interface - gh project close] Screen reader is announcing incorrect control information while navigating between the controls which appear as a result after running 'gh project close' command.
  • [GitHubCLI1.31] [GitHub CLI Basic Interface - gh project view] Screen reader is announcing as "blank" while navigating between the controls which appear as a result after running 'gh project view' command.
1.3.2 Meaningful Sequence

Supports
1.3.3 Sensory Characteristics

Supports
1.4.1 Use of Color

Partially Supports

Exceptions include:

  • [GitHubCLI1.20] [GitHub CLI Basic Interface - gh cache] The luminosity contrast ratio of the 'https://github.com/shivam2250/testing-123' link with surrounding text is 1:1 which is less than required contrast ratio of 3:1
  • [GitHubCLI1.1] [GitHub CLI Basic Interface - gh cache] The luminosity contrast ratio of the 'https://cli.github.com/manual' link with surrounding text is 1:1 which is less than required contrast ratio of 3:1
1.4.2 Audio Control

Supports
2.1.1 Keyboard

Supports
2.1.2 No Keyboard Trap

Supports
2.1.4 Character Key Shortcuts

Supports
2.2.1 Timing Adjustable

Supports
2.2.2 Pause Stop Hide

Supports
2.3.1 Three Flashes or Below Threshold

Supports
2.4.1 Bypass Blocks

Supports
2.4.2 Page Titled

Supports
2.4.3 Focus Order

Supports
2.4.4 Link Purpose (In Context)

Supports
2.5.1 Pointer Gestures

Supports
2.5.2 Pointer Cancellation

Supports
2.5.3 Label in Name

Supports
2.5.4 Motion Actuation

Supports
3.1.1 Language of Page

Supports
3.2.1 On Focus

Supports
3.2.2 On Input

Supports
3.3.1 Error Identification

Supports
3.3.2 Labels or Instructions

Supports
4.1.1 Parsing

Supports
4.1.2 Name Role Value

Supports

Level AA Success Criteria

Success Criteria Conformance Level Remarks and Explanations
1.2.4 Captions (Live)

Supports
1.2.5 Audio Description (Prerecorded)

Supports
1.3.4 Orientation

Supports
1.3.5 Identify Input Purpose

Supports
1.4.3 Contrast (Minimum)

Partially Supports

Exceptions include:

  • [GitHubCLI1.20] [GitHub CLI Basic Interface - gh repo view] The luminosity contrast ratio of the 'This repository does not have a README' text with its background is 3.7:1 which is less than required ratio of 4.5:1.
  • [GitHubCLI1.39] [GitHub CLI Basic Interface - gh reference] The luminosity contrast ratio for the 'gh variable <command>' text is 4.4:1 which is less than required ratio of 4.5:1.
  • [GitHubCLI1.46] [GitHub CLI Basic Interface - gh search] The luminosity contrast ratio for the 'd3/d3' text is 2.4:1 which is less than required ratio of 4.5:1.
  • [GitHubCLI1.20] [GitHub CLI Basic Interface - gh repo view] The luminosity contrast ratio for the link text which appear as a result after running 'gh repo view' command is less than required contrast ratio 4.5:1.
  • [GitHubCLI1.20] [GitHub CLI Basic Interface - gh repo view] The luminosity contrast ratio for the text-'create a release based workflow' is 4.4:1 which is less than required contrast ratio 4.5:1.
  • [GitHubCLI1.30] [GitHub CLI Basic Interface - gh codespace create] The Luminosity contrast ratio for the text-'Sorry, your reply was invalid: Value is required' is 3.2:1 which is less than required contrast ratio is 4.5:1
1.4.4 Resize text

Supports
1.4.5 Images of Text

Supports
1.4.10 Reflow

Supports
1.4.11 Non-text Contrast

Supports
1.4.12 Text-spacing

Supports
1.4.13 Content on Hover or Focus

Supports
2.4.5 Multiple Ways

Supports
2.4.6 Headings and Labels

Supports
2.4.7 Focus Visible

Supports
3.1.2 Language of Parts

Supports
3.2.3 Consistent Navigation

Supports
3.2.4 Consistent Identification

Supports
3.3.3 Error Suggestion

Supports
3.3.4 Error Prevention (LFD)

Supports
4.1.3 Status Messages

Supports

Disclaimer

©2024 GitHub Inc. All rights reserved. The names of actual companies and products mentioned herein may be the trademarks of their respective owners. The information contained in this document represents the current view of GitHub Inc. on the issues discussed as of the date of publication. GitHub cannot guarantee the accuracy of any information presented after the date of publication.

GitHub’s WCAG 2.1 conformance reports provide the information included in ITI’s “VPAT® 2.4Rev WCAG (March 2022)” template. “Voluntary Product Accessibility Template” and “VPAT” are registered service marks of the Information Technology Industry Council (ITI). This document includes material copied from or derived from the Web Content Accessibility Guidelines (WCAG 2.1). Copyright © 2017-2018 W3C® (MIT, ERCIM, Keio, Beihang). This document is not the Web Content Accessibility Guidelines (WCAG) and should not be used as a substitute for it. Excerpts of WCAG are referenced solely for purposes of detailing GitHub’s conformance with the relevant provisions. A full and complete copy of the Guidelines is available from the W3C WAI.

GitHub regularly updates its websites and provides new information about the accessibility of products as that information becomes available. Customization of the product voids this conformance statement from GitHub. Customers may make independent conformance statements if they have conducted due diligence to meet all relevant requirements for their customization. Please consult with Assistive Technology (AT) vendors for compatibility specifications of specific AT products. This document is for informational purposes only. GitHub MAKES NO WARRANTIES, EXPRESS OR IMPLIED, IN THIS DOCUMENT.

Back to conformance reports