COMMAND LINE

Use Standards

Adopt, check, fix, diagnose, and update sarj-ai standards (v3.0.1).

QUICK START

Set up a repository

Install the tool, configure the repository, then verify it:

uv tool install --python 3.14 sarj-standards
sarj-standards setup
sarj-standards doctor
sarj-standards check

Run setup without installing the CLI

uvx --isolated --python 3.14 --from sarj-standards sarj-standards setup

Command sarj-standards --help

EVERY COMMAND

Global options

-h, --help: show this help message and exit
--version: show program's version number and exit
--root DEST: repository root shared by the selected command (default: current directory)

DOCTOR

`sarj-standards doctor`

diagnose adoption health and optionally repair safe drift

sarj-standards doctor [-h] [--format OUTPUT_FORMAT] [--repair] [--no-install]

-h, --help: show this help message and exit
--format OUTPUT_FORMAT: output format (default: text) Choices: text, json
--repair: transactionally repair safe drift with the executing bundle, then re-diagnose
--no-install: with --repair, update configuration without installing dependencies or hooks

SETUP

`sarj-standards setup`

adopt or converge the repository in one idempotent operation

sarj-standards setup [-h] [--hooks HOOKS] [--python-dest PYTHON_DEST] [--typescript-dest TYPESCRIPT_DEST] [--dry-run] [--profile PROFILE] [--no-install] [--config ONLY ...]

-h, --help: show this help message and exit
--hooks HOOKS: hook manager (default: detect Lefthook, otherwise pre-commit) Choices: pre-commit, lefthook, none
--python-dest PYTHON_DEST: the directory that owns pyproject.toml (default: detected)
--typescript-dest TYPESCRIPT_DEST: the directory that owns the npm lockfile (default: detected)
--dry-run: print the complete plan without writing
--profile PROFILE: policy profile to adopt (default: existing value, otherwise standard) Choices: standard, application
--no-install: write wiring without installing dependencies or hooks
--config ONLY: select one config explicitly (repeatable) Choices: eslint, markdownlint, pyright, ruff, taplo, yamllint

CHECK

`sarj-standards check`

run the complete quality gate or check selected paths

sarj-standards check [-h] [--trust-repository-code] [--staged] [--format OUTPUT_FORMAT] [--output OUTPUT] [--max-annotations-per-level MAX_ANNOTATIONS_PER_LEVEL] [files ...]

-h, --help: show this help message and exit
--trust-repository-code: allow executable repository ESLint configuration (generated hooks and CI set this explicitly)
--staged: run custom rules on hook-supplied paths, or discover staged files when none are supplied
--format OUTPUT_FORMAT: Choices: text, json, sarif, github
--output OUTPUT: write JSON or SARIF atomically to PATH
--max-annotations-per-level MAX_ANNOTATIONS_PER_LEVEL: Choices: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
files: selected paths; when omitted, check the complete repository

FIX

`sarj-standards fix`

apply safe formatting and lint fixes

sarj-standards fix [-h]

-h, --help: show this help message and exit

UPDATE

`sarj-standards update`

upgrade the complete coherent Standards bundle

sarj-standards update [-h] [--check] [--offline] [--no-install]

-h, --help: show this help message and exit
--check: preview without writing; exit 1 when changes exist
--offline: use the executing bundle without resolving latest
--no-install: do not install dependencies or hooks

EXCLUDE

`sarj-standards exclude`

inspect or change explicit path and rule exclusions

sarj-standards exclude [-h] {list,add,remove}

-h, --help: show this help message and exit

SHOW

`sarj-standards show`

print read-only package and adoption information

sarj-standards show [-h] {state,configs,config,peers,rules,ci}

-h, --help: show this help message and exit

MAINTAIN

`sarj-standards maintain`

repository policy, hooks, rule ledgers, and releases

sarj-standards maintain [-h] {setup,release,check,sync-ledger,docs,comment-corpus,hooks,rules,catalog,cli-reference}

-h, --help: show this help message and exit

Start with `sarj-standards setup`, then use `sarj-standards check`.