Commands
The b8e CLI exposes the following commands. Global options below apply to every command.
Global options
Section titled “Global options”| Option | Takes | Default | Description |
|---|---|---|---|
-V, --version | boolean | print the CLI version | |
--org <id|slug|name> | value | organization context | |
-y, --yes | boolean | skip all prompts and accept defaults | |
--non-interactive | boolean | never prompt; fail instead of asking | |
--progress <mode> | value | how progress is reported | |
-q, --quiet | boolean | suppress progress output (same as —progress quiet) | |
--no-color | negation | disable color | |
-v, --verbose | boolean | verbose diagnostics |
The -h, --help option is available on the root and every subcommand.
b8e --help
Section titled “b8e --help”Usage: b8e [options] [command]
Find accessibility problems in your code — scans locally, sign in to run it.
Options: -V, --version print the CLI version --org <id|slug|name> organization context [$BINCLUSIVE_ORG_ID] -y, --yes skip all prompts and accept defaults --non-interactive never prompt; fail instead of asking --progress <mode> how progress is reported (choices: "auto", "plain", "json", "quiet") -q, --quiet suppress progress output (same as --progress quiet) --no-color disable color -v, --verbose verbose diagnostics -h, --help display help for command
CORE COMMANDS scan [options] [dir] Scan a path (or --url) for accessibility findings ci [options] [dir] Scan + report + exit non-zero on gating findings (CI gate) baseline [options] [dir] snapshot accepted findings, or list them
PROJECT COMMANDS init [options] [dir] write binclusive.json (--ci/--mcp/--all/--extends scaffold more concerns) gen [options] [dir] regenerate BINCLUSIVE.md from binclusive.json (--check guards drift in CI) add [options] <concern> [dir] add one concern (ci|mcp) after init — the post-init twin of `init --ci/--mcp` suggest [options] [dir] suggest declarations.components entries (read-only unless --write)
AUDIT COMMANDS audit [options] Run an accessibility audit build upload a mobile build ticket List and view violation tickets qa run regression steps as an ordinary user profile capture or list persona logins
ADDITIONAL COMMANDS auth Authenticate b8e (login, logout, status) rules [options] List the deterministic scanner's WCAG coverage catalog (what we check) doctor [options] Check this machine can run a local audit; --platform checks one platform install-android-audit-agent [options] install the Android audit agent this CLI drives accept Accept operations allow Allow operations approve Approve operations archive Archive operations assign Assign operations browser Browser operations change Change operations check Check operations cloud Cloud operations configure Configure operations create Create operations delete Delete operations describe Describe operations dismiss Dismiss operations edit Edit operations export Export operations flags [options] Evaluate a set of feature flags. Targeting context is built server-side from the session and optional route-scoped organization; returns resolved booleans only. font Font operations get Get operations hide Hide operations import Import operations invite Invite operations leave Leave operations list List operations org switch the active organization, or list them project [options] select the project findings belong to, or list them open Open operations platform Platform operations post Post operations record Record operations redescribe Redescribe operations reject Reject operations remove Remove operations rescan Rescan operations resolve Resolve operations revoke Revoke operations run Run operations set Set operations start Start operations starting Starting operations update Update operations widget Widget operations withdraw Withdraw operations
Commands: help [command] display help for command
Start here: b8e auth login sign in — every command except auth and doctor needs a credential b8e scan ./src find accessibility problems in your code, locally b8e project choose where scan's findings go (no project: they stay on your machine) b8e init --ci add the CI gate to the repo; on a runner the credential is BINCLUSIVE_API_KEY
EXAMPLES $ b8e scan ./src $ b8e baseline . $ b8e ci --enforce block
LEARN MORE Use `b8e <command> <subcommand> --help` for more information about a command. Read the docs at https://docs.binclusive.io/cliCommand pages
Section titled “Command pages”| Command | Summary |
|---|---|
scan | Scan a path (or —url) for accessibility findings |
ci | Scan + report + exit non-zero on gating findings (CI gate) |
baseline | snapshot accepted findings, or list them |
init | write binclusive.json (—ci/—mcp/—all/—extends scaffold more concerns) |
gen | regenerate BINCLUSIVE.md from binclusive.json (—check guards drift in CI) |
add | add one concern (ci|mcp) after init — the post-init twin of init --ci/--mcp |
suggest | suggest declarations.components entries (read-only unless —write) |
audit | Run an accessibility audit |
build | upload a mobile build |
ticket | List and view violation tickets |
qa | run regression steps as an ordinary user |
auth | Authenticate b8e (login, logout, status) |
rules | List the deterministic scanner’s WCAG coverage catalog (what we check) |
doctor | Check this machine can run a local audit; —platform checks one platform |
install-android-audit-agent | install the Android audit agent this CLI drives |
accept | Accept operations |
allow | Allow operations |
approve | Approve operations |
archive | Archive operations |
assign | Assign operations |
profile | capture or list persona logins |
browser | Browser operations |
change | Change operations |
check | Check operations |
cloud | Cloud operations |
configure | Configure operations |
create | Create operations |
delete | Delete operations |
describe | Describe operations |
dismiss | Dismiss operations |
edit | Edit operations |
export | Export operations |
flags | Evaluate a set of feature flags. Targeting context is built server-side from the session and optional route-scoped organization; returns resolved booleans only. |
font | Font operations |
get | Get operations |
hide | Hide operations |
import | Import operations |
invite | Invite operations |
leave | Leave operations |
list | List operations |
org | switch the active organization, or list them |
project | select the project findings belong to, or list them |
open | Open operations |
platform | Platform operations |
post | Post operations |
record | Record operations |
redescribe | Redescribe operations |
reject | Reject operations |
remove | Remove operations |
rescan | Rescan operations |
resolve | Resolve operations |
revoke | Revoke operations |
run | Run operations |
set | Set operations |
start | Start operations |
starting | Starting operations |
update | Update operations |
widget | Widget operations |
withdraw | Withdraw operations |