Docs / Running Lintsure
CLI
Every command, flag, output file and exit code of the lintsure command.
Usage
lintsure scan [path] [options]
path defaults to the current folder. Running lintsure with no command prints help.
Options
| Flag | What it does |
|---|---|
--framework <ids> |
Comma-separated frameworks to check: eu-ai-act, gdpr, soc2, iso-27001. Overrides lintsure.config.yaml. |
--json |
Also write lintsure-report.json. |
--report |
Also write lintsure-assessment.html, a multi-page report to review, print or save as PDF. See Assessment report. |
--project <name> |
Project name on the assessment cover. Defaults to the folder name. |
--fail-on gap |
Exit with code 1 if there is at least one Gap. |
--fail-on partial |
Exit with code 1 if there is at least one Gap or Partial. |
Without --framework, Lintsure reads lintsure.config.yaml in the scanned folder. With no config file either, it checks every available framework. See Configuration.
Output
- A summary line, then one line per finding: status,
file:line, title. lintsure-report.mdin the folder you ran the command from, andlintsure-report.jsonwith--json. See Report format.- If your config lists frameworks Lintsure doesn’t check yet, it prints
Skipping, not checked yet:followed by their ids.
Exit codes
| Code | Meaning |
|---|---|
| 0 | The scan finished and no --fail-on condition was met |
| 1 | The scan finished and a --fail-on condition was met |
| 2 | Unknown command, unknown framework id, or an error during the scan |
Examples
# check the current folder against everything available
lintsure scan
# only GDPR and SOC 2, write JSON too, fail CI on any gap
lintsure scan ./api --framework gdpr,soc2 --json --fail-on gap
Lintsure is a readiness tool, not an audit or legal advice. Results cover code only; a qualified person should review them. Disclaimer