0.7.2-autherrors.2 • Published 2 months ago
@stark-test/accessibility-cli v0.7.2-autherrors.2
Stark accessibility CLI
Stark's accessibility tooling brought to a cli. By the developers, for the developers!
Usage
$ npm install -g @stark-test/accessibility-cli
$ stark-accessibility COMMAND
running command...
$ stark-accessibility (--version)
@stark-test/accessibility-cli/0.7.2-autherrors.2 linux-x64 node-v18.19.1
$ stark-accessibility --help [COMMAND]
USAGE
$ stark-accessibility COMMAND
...
Commands
stark-accessibility config install
installs browserchrome alongside the cli.
USAGE
$ stark-accessibility config install [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
installs browser[chrome] alongside the cli.
EXAMPLES
$ stark-accessibility config install
stark-accessibility help [COMMANDS]
Display help for stark-accessibility.
USAGE
$ stark-accessibility help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for stark-accessibility.
See code: @oclif/plugin-help
stark-accessibility scan
scans a given resource(s) for accessibility issues, optionally sends reports to your stark account
USAGE
$ stark-accessibility scan --authentication-mode none|basic|page -U <value> [--json]
[--authentication-password <value>] [--authentication-username <value>] [--authentication-page-url <value>]
[--authentication-page-selectors <value>] [-M <value>] [--puppeteer-timeout <value>] [--puppeteer-wait-until
load|domcontentloaded|networkidle0|networkidle2] [--reuse-page] [-S auto|on|off] [--scan-delay <value>]
[--skip-errors] [--stealth-mode] [-V Blackberry PlayBook|Blackberry PlayBook landscape|BlackBerry Z30|BlackBerry Z30
landscape|Galaxy Note 3|Galaxy Note 3 landscape|Galaxy Note II|Galaxy Note II landscape|Galaxy S III|Galaxy S III
landscape|Galaxy S5|Galaxy S5 landscape|Galaxy S8|Galaxy S8 landscape|Galaxy S9+|Galaxy S9+ landscape|Galaxy Tab
S4|Galaxy Tab S4 landscape|iPad|iPad landscape|iPad (gen 6)|iPad (gen 6) landscape|iPad (gen 7)|iPad (gen 7)
landscape|iPad Mini|iPad Mini landscape|iPad Pro|iPad Pro landscape|iPad Pro 11|iPad Pro 11 landscape|iPhone
4|iPhone 4 landscape|iPhone 5|iPhone 5 landscape|iPhone 6|iPhone 6 landscape|iPhone 6 Plus|iPhone 6 Plus
landscape|iPhone 7|iPhone 7 landscape|iPhone 7 Plus|iPhone 7 Plus landscape|iPhone 8|iPhone 8 landscape|iPhone 8
Plus|iPhone 8 Plus landscape|iPhone SE|iPhone SE landscape|iPhone X|iPhone X landscape|iPhone XR|iPhone XR
landscape|iPhone 11|iPhone 11 landscape|iPhone 11 Pro|iPhone 11 Pro landscape|iPhone 11 Pro Max|iPhone 11 Pro Max
landscape|iPhone 12|iPhone 12 landscape|iPhone 12 Pro|iPhone 12 Pro landscape|iPhone 12 Pro Max|iPhone 12 Pro Max
landscape|iPhone 12 Mini|iPhone 12 Mini landscape|iPhone 13|iPhone 13 landscape|iPhone 13 Pro|iPhone 13 Pro
landscape|iPhone 13 Pro Max|iPhone 13 Pro Max landscape|iPhone 13 Mini|iPhone 13 Mini landscape|JioPhone 2|JioPhone
2 landscape|Kindle Fire HDX|Kindle Fire HDX landscape|LG Optimus L70|LG Optimus L70 landscape|Microsoft Lumia
550|Microsoft Lumia 950|Microsoft Lumia 950 landscape|Nexus 10|Nexus 10 landscape|Nexus 4|Nexus 4 landscape|Nexus
5|Nexus 5 landscape|Nexus 5X|Nexus 5X landscape|Nexus 6|Nexus 6 landscape|Nexus 6P|Nexus 6P landscape|Nexus 7|Nexus
7 landscape|Nokia Lumia 520|Nokia Lumia 520 landscape|Nokia N9|Nokia N9 landscape|Pixel 2|Pixel 2 landscape|Pixel 2
XL|Pixel 2 XL landscape|Pixel 3|Pixel 3 landscape|Pixel 4|Pixel 4 landscape|Pixel 4a (5G)|Pixel 4a (5G)
landscape|Pixel 5|Pixel 5 landscape|Moto G4|Moto G4 landscape|None]
FLAGS
-M, --min-score=<value>
Exits the cli with exit code 1 if score is below given percentage
-S, --sandbox-mode=<option>
[default: auto] Determine sandbox mode for browser
<options: auto|on|off>
-U, --url=<value>...
(required) Scan the given urls for accessibility issues. You can pass in a --url multiple times.
-V, --view-port=<option>
[default: None] Set browser to a specific mobile device. Defaults to None which loads a browser in 800x600
<options: Blackberry PlayBook|Blackberry PlayBook landscape|BlackBerry Z30|BlackBerry Z30 landscape|Galaxy Note
3|Galaxy Note 3 landscape|Galaxy Note II|Galaxy Note II landscape|Galaxy S III|Galaxy S III landscape|Galaxy
S5|Galaxy S5 landscape|Galaxy S8|Galaxy S8 landscape|Galaxy S9+|Galaxy S9+ landscape|Galaxy Tab S4|Galaxy Tab S4
landscape|iPad|iPad landscape|iPad (gen 6)|iPad (gen 6) landscape|iPad (gen 7)|iPad (gen 7) landscape|iPad Mini|iPad
Mini landscape|iPad Pro|iPad Pro landscape|iPad Pro 11|iPad Pro 11 landscape|iPhone 4|iPhone 4 landscape|iPhone
5|iPhone 5 landscape|iPhone 6|iPhone 6 landscape|iPhone 6 Plus|iPhone 6 Plus landscape|iPhone 7|iPhone 7
landscape|iPhone 7 Plus|iPhone 7 Plus landscape|iPhone 8|iPhone 8 landscape|iPhone 8 Plus|iPhone 8 Plus
landscape|iPhone SE|iPhone SE landscape|iPhone X|iPhone X landscape|iPhone XR|iPhone XR landscape|iPhone 11|iPhone
11 landscape|iPhone 11 Pro|iPhone 11 Pro landscape|iPhone 11 Pro Max|iPhone 11 Pro Max landscape|iPhone 12|iPhone 12
landscape|iPhone 12 Pro|iPhone 12 Pro landscape|iPhone 12 Pro Max|iPhone 12 Pro Max landscape|iPhone 12 Mini|iPhone
12 Mini landscape|iPhone 13|iPhone 13 landscape|iPhone 13 Pro|iPhone 13 Pro landscape|iPhone 13 Pro Max|iPhone 13
Pro Max landscape|iPhone 13 Mini|iPhone 13 Mini landscape|JioPhone 2|JioPhone 2 landscape|Kindle Fire HDX|Kindle
Fire HDX landscape|LG Optimus L70|LG Optimus L70 landscape|Microsoft Lumia 550|Microsoft Lumia 950|Microsoft Lumia
950 landscape|Nexus 10|Nexus 10 landscape|Nexus 4|Nexus 4 landscape|Nexus 5|Nexus 5 landscape|Nexus 5X|Nexus 5X
landscape|Nexus 6|Nexus 6 landscape|Nexus 6P|Nexus 6P landscape|Nexus 7|Nexus 7 landscape|Nokia Lumia 520|Nokia
Lumia 520 landscape|Nokia N9|Nokia N9 landscape|Pixel 2|Pixel 2 landscape|Pixel 2 XL|Pixel 2 XL landscape|Pixel
3|Pixel 3 landscape|Pixel 4|Pixel 4 landscape|Pixel 4a (5G)|Pixel 4a (5G) landscape|Pixel 5|Pixel 5 landscape|Moto
G4|Moto G4 landscape|None>
--authentication-mode=<option>
(required) [default: none] Specify what kind of authentication is required before navigating to the given urls
<options: none|basic|page>
--puppeteer-timeout=<value>
[default: 30000] Navigation timeout for puppeteer
--puppeteer-wait-until=<option>...
[default: load] Wait until params for puppeteer
<options: load|domcontentloaded|networkidle0|networkidle2>
--reuse-page
Use the same page for scanning all urls. Defaults to false.
--scan-delay=<value>
[default: 100] Delay scan after page has been navigated to in MS
--skip-errors
Continue to scanning the next url if an error occurs
--stealth-mode
Run puppeteer in stealth mode
PAGE AUTHENTICATION FLAGS
--authentication-page-selectors=<value> Specify selectors for page authentication separated by a semicolon in the
format [username;password;button]
--authentication-page-url=<value> Specify url for authentication. Pass this along with
--authentication-mode=page.
--authentication-password=<value> Specify password for authentication. A --authentication-mode needs to be
setup first.
--authentication-username=<value> Specify username for authentication. A --authentication-mode needs to be
setup first.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
scans a given resource(s) for accessibility issues, optionally sends reports to your stark account
EXAMPLES
$ stark-accessibility scan
FLAG DESCRIPTIONS
-M, --min-score=<value> Exits the cli with exit code 1 if score is below given percentage
Given a value [0-100], the cli will exit with an error code (1) if the score is lesser. Score is the
percentage of passed checks over total checks. The default value is 0
-S, --sandbox-mode=auto|on|off Determine sandbox mode for browser
Specify if browser should run in sandbox. Auto mode disables sandbox only when in a container environment.
[on/off] forces sandbox mode to be [on/off]
--authentication-mode=none|basic|page
Specify what kind of authentication is required before navigating to the given urls
Specify authentication mode for accessing the given set of urls. Choose between basic and page mode. Basic mode does
basic navigation and is the fastest. Page mode will navigate to a login page url every time before the given
urls
--authentication-page-selectors=<value>
Specify selectors for page authentication separated by a semicolon in the format [username;password;button]
Specify the selectors to interact with during page mode authentication. You need to set username with
--authentication-username and password with password with --authentication-password flags and set
--authentication-mode=page
--authentication-page-url=<value> Specify url for authentication. Pass this along with --authentication-mode=page.
Specify the page to authenticate before navigating to any page. You need to set username with
--authentication-username and password with password with --authentication-password flags and set
--authentication-mode=page
--authentication-password=<value>
Specify password for authentication. A --authentication-mode needs to be setup first.
Specify the password along with username with --authentication-username flag and --authentication-mode
--authentication-username=<value>
Specify username for authentication. A --authentication-mode needs to be setup first.
Specify the username along with password with --authentication-password flag and --authentication-mode
--puppeteer-timeout=<value> Navigation timeout for puppeteer
Timeout in milliseconds before puppeteer fails
--puppeteer-wait-until=load|domcontentloaded|networkidle0|networkidle2... Wait until params for puppeteer
Wait until a browser event is completed
--reuse-page Use the same page for scanning all urls. Defaults to false.
Keep using a single page to scan all urls. This can be beneficial in cases when the logged in session only stays on
a page. This can cause issues if the scans are dependent on having navigated to a clean page. A new page is
used by default. Cookies are still preserved.
--scan-delay=<value> Delay scan after page has been navigated to in MS
Integer delay in ms to run the scanner on a loaded page. Add a delay to just be sure all elements are available
--skip-errors Continue to scanning the next url if an error occurs
Setting skip-errors to true will continue scanning the next url in the list of urls. If there is only one url
or if all scans errored out, the cli will run to a successful completion
--stealth-mode Run puppeteer in stealth mode
Enables puppeteer-extra which attempts to runs puppeteer in a mode where websites can't detect that this is a bot
0.7.2-autherrors.2
2 months ago
0.7.2-autherrors.1
2 months ago
0.7.2-autherrors.0
2 months ago
0.7.1-authmode.3
2 months ago
0.7.1-authmode.1
3 months ago
0.7.1-authmode.0
3 months ago
0.7.1-authmode.2
3 months ago
0.7.1-bump-ruleengine.0
3 months ago
0.7.0-authmode.0
4 months ago
0.5.0-basic-wraith.0
6 months ago
0.5.0-chatty-wraith.0
6 months ago
0.5.0-sneaky-wraith.3
6 months ago
0.5.0-sneaky-brian.0
6 months ago
0.5.0-sneaky-wraith.0
6 months ago
0.5.0-wraith.3
6 months ago
0.5.0-wraith.2
6 months ago
0.5.0-wraith.1
6 months ago
0.5.0-wraith.0
6 months ago
0.4.0-beta.0-XwY4Gh
6 months ago
0.3.1-beta.0-YWJoa
7 months ago
0.3.0-beta.0
7 months ago
0.2.1-beta.1
9 months ago
0.2.1-beta.0
9 months ago
0.2.0-beta.0
9 months ago