kayle_cli

The kayle CLI, for web accessibility audits. [WIP]

Requirements

Node.js is required.

Installation

If Rust is installed.

1cargo install kayle_cli
2# or with node.
3npm install kayle_cli

Getting Started

Make sure you have an automation lib installed. Use the arg --automation-lib to switch from the default puppeteer to playwright.

1kayle_cli --automation-lib puppeteer install
2# configure the audits
3kayle_cli --automation-lib puppeteer --standard wcag2aa configure

Pass in a list of urls to get the results.

1The kayle CLI for web accessibility auditing
2
3Usage: kayle_cli [OPTIONS] [ALLOW_IMAGES] [CLIP] [CLIP_DIR] [CLIP_2_BASE64] <COMMAND>
4
5Commands:
6  upgrade    Upgrade kayle and the dependencies required
7  install    Install kayle and the dependencies required
8  configure  Configure the audit to disk to re-use across runs
9  help       Print this message or the help of the given subcommand(s)
10
11Arguments:
12  [ALLOW_IMAGES]
13          Allow images to render, useful when setting clip option for bounding box
14          
15          [possible values: true, false]
16
17  [CLIP]
18          Get the bounding box of an element
19          
20          [possible values: true, false]
21
22  [CLIP_DIR]
23          The directory to store clip images
24
25  [CLIP_2_BASE64]
26          Convert the clip to a base64 image
27          
28          [possible values: true, false]
29
30Options:
31  -s, --standard <STANDARD>
32          The accessibility standard to run
33
34          Possible values:
35          - wcag2a:     WCAG2A
36          - wcag2aa:    WCAG2AA
37          - wcag2aaa:   WCAG2AAA
38          - section508: Section508
39
40      --include-warnings <INCLUDE_WARNINGS>
41          Include warnings in the audit
42          
43          [possible values: true, false]
44
45      --include-notices <INCLUDE_NOTICES>
46          Include notices in the audit
47          
48          [possible values: true, false]
49
50  -r, --runners <RUNNERS>
51          The accessibility runner to use htmlcs, axecore, or kayle
52
53          Possible values:
54          - kayle:  Kayle
55          - htmlcs: htmlcs
56          - axe:    axe
57
58  -w, --wait-for <WAIT_FOR>
59          WaitFor event for content to exist
60
61          Possible values:
62          - load:              Waits till the window load event
63          - domcontent-loaded: The dom loaded content first
64          - commit:            Wait for the commit event. Playwright only
65          - network-idle:      Waits till there are no more network connections for at least 500 ms. Playwright only
66          - network-idle1:     Waits till there are no more network connections for at least 500 ms. Puppeteer only
67          - network-idle2:     Waits till there are no more than 2 network connections for at least 500 ms. Puppeteer only
68
69      --automation-lib <AUTOMATION_LIB>
70          The automation lib to use either puppeteer or playwright
71
72          Possible values:
73          - puppeteer:  The puppeteer library. Defaults to this
74          - playwright: The playwright library by microsoft
75
76  -h, --help
77          Print help (see a summary with '-h')
78
79  -V, --version
80          Print version

1kayle_cli https://www.drake.com
2{"documentTitle":"Drake Industries | Custom, Durable, High-Quality Labels, Asset Tags and Custom Server Bezels","pageUrl":"https://www.drake.com/","issues":[{"context":"<h5 class=\"normal\">\n<div class=\"span12 widget-span ...</h5>","selector":"body>:nth-child(2)>:nth-child(1)>:nth-child(2)>:nth-child(1)>:nth-child(1)>:nth-child(2)>:nth-child(1)>:nth-child(1)>:nth-child(2)>:nth-child(1)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_3.1_3_1_A.G141","type":"error","typeCode":1,"message":"The heading structure is not logically nested. This h5 element should be an h2 to be properly nested.","runner":"htmlcs","recurrence":0},{"context":"<h5>Labels</h5>","selector":"#hs_cos_wrapper_module_1569856007055222>:nth-child(1)>:nth-child(2)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_3.1_3_1_A.G141","type":"error","typeCode":1,"message":"The heading structure is not logically nested. This h5 element should be an h3 to be properly nested.","runner":"htmlcs","recurrence":0},{"context":"<a href=\"https://www.drake.com/labels?hsLang=en\">Learn more</a>","selector":"#hs_cos_wrapper_module_1569856007055222>:nth-child(1)>:nth-child(3)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail","type":"error","typeCode":1,"message":"This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.44:1. Recommendation:  change text colour to #00171d.","runner":"htmlcs","recurrence":0},{"context":"<a href=\"https://www.drake.com/name-plates?hsLang=en\">Learn more</a>","selector":"#hs_cos_wrapper_module_1569856034269224>:nth-child(1)>:nth-child(3)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail","type":"error","typeCode":1,"message":"This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.44:1. Recommendation:  change text colour to #00171d.","runner":"htmlcs","recurrence":0},{"context":"<a href=\"https://www.drake.com/equipment-panel-overlays?hsLang=en\">Learn more</a>","selector":"#hs_cos_wrapper_module_1569856037305225>:nth-child(1)>:nth-child(3)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail","type":"error","typeCode":1,"message":"This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.44:1. Recommendation:  change text colour to #00171d.","runner":"htmlcs","recurrence":0},{"context":"<a href=\"https://www.drake.com/membrane-switches?hsLang=en\">Learn more</a>","selector":"#hs_cos_wrapper_module_1569856084644237>:nth-child(1)>:nth-child(3)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail","type":"error","typeCode":1,"message":"This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.44:1. Recommendation:  change text colour to #00171d.","runner":"htmlcs","recurrence":0},{"context":"<a href=\"https://www.drake.com/oem-bezel-re-branding?hsLang=en\">Learn more</a>","selector":"#hs_cos_wrapper_module_1569856082608235>:nth-child(1)>:nth-child(3)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail","type":"error","typeCode":1,"message":"This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.44:1. Recommendation:  change text colour to #00171d.","runner":"htmlcs","recurrence":0},{"context":"<a href=\"https://www.drake.com/safety?hsLang=en\">Learn more</a>","selector":"#hs_cos_wrapper_module_1569856080132233>:nth-child(1)>:nth-child(3)>:nth-child(1)","code":"WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail","type":"error","typeCode":1,"message":"This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.44:1. Recommendation:  change text colour to #00171d.","runner":"htmlcs","recurrence":0},{"context":"<a class=\"expandMenu\"><i></i><i></i><i></i></a>","selector":"#hs_cos_wrapper_module_14725592865174>:nth-child(1)","code":"WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.A.EmptyNoId","type":"error","typeCode":1,"message":"Anchor element found with no link content and no name and/or ID attribute.","runner":"htmlcs","recurrence":0}],"meta":{"errorCount":9,"warningCount":0,"noticeCount":0,"accessScore":100},"automateable":{"missingAltIndexs":[]}}%