CLI reference¶
Lintel' command-line interface is deliberately small. Each command has a single purpose; combining them is usually done in a Git hook or a CI script, not by stringing multiple lintel invocations together.
| Command | Purpose |
|---|---|
init |
Create .lintel/lintel.yaml with secure defaults |
install |
Install Git hooks that dispatch to lintel run |
uninstall |
Remove Lintel-installed hooks |
run |
Run all enabled checks (honors --hook and --check) |
doctor |
Verify scanner binaries, versions, and SHA256 hashes |
baseline |
Snapshot current findings into .lintel/baseline.json |
ignore |
Add a rule to .lintel/allowlist.yaml |
fmt |
Shortcut for lintel run --check format |
explain |
Print documentation pointer for a rule |
version |
Print lintel version and schema version |
Global flags¶
These flags are available on every command:
| Flag | Default | Purpose |
|---|---|---|
--config |
.lintel/lintel.yaml |
Path to the config file |
--repo |
$PWD |
Repository root |
--output |
pretty |
Output format: pretty, json, sarif, junit |
--no-color |
auto | Disable ANSI colors |
--verbose |
off | Include debug output |
--quiet |
off | Only emit errors |
-h, --help |
Help for the command |
--output sarif and --output junit are v1.1 and produce an informative error on v1.0.
Exit codes¶
See exit codes reference. TL;DR:
| Code | Meaning |
|---|---|
| 0 | Gate passed |
| 1 | Gate failed |
| 2 | Config / CLI error |
| 3 | Binary resolve or verification failed |
| 4 | Scanner crashed or timed out |