Skip to content

Docs / Getting started

Lintsure docs

Everything you need to run Lintsure, read its results and add rules. Written against the current code, version 0.1.

Early release. Lintsure is at version 0.1, in Beta. These docs describe what the code does today. See Status and limits for what's still missing.

Getting started

lintsure scan .
Quickstart →Run your first check.
scout → classifier → checker
→ auditor → fixer · officer
How Lintsure works →The agents, the rules and what stays local.

Running Lintsure

--framework gdpr,soc2
--json --fail-on gap
CLI →Commands, flags and exit codes.
tools: scan · classify
explain_framework · explain_rule
MCP server →Use Lintsure inside your coding agent.
uses: lintsure/action@v1
GitHub Action →Check every pull request.
frameworks:
  - gdpr
  - soc2
Configuration →Choose which frameworks to check.

Results

gap · partial · met
outside code
Findings and statuses →Gap, Partial, Met and Outside code.
lintsure-report.md
lintsure-report.json
Report format →The Markdown and JSON reports.
lintsure scan --report
Assessment report →A multi-page report to review and sign.

Reference

16 rules · v0.1.1
Rules →Every rule and what it maps to.
EU AI Act
GDPR
SOC 2
ISO/IEC 27001
Frameworks →What each framework asks, and what code can prove.

Project

network calls: 0
Privacy and security →What Lintsure reads and never sends.
npm test
git commit -s
Contributing →Write a rule, run the tests, send a PR.
v0.1 · early
Status and limits →What works today and what doesn't yet.
0.1.0 · 2026-11-07
Changelog →What changed, release by release.

Lintsure is a readiness tool, not an audit or legal advice. Results cover code only; a qualified person should review them. Disclaimer