Usage#

Basic usage#

Analyse a document#
Pass a PDF file as argument:
```
integritylens document.pdf
```
Quadrant IntegrityLens extracts the text, runs all enabled scanners, and displays the findings in the terminal. Each finding shows the scanner that triggered it, a confidence level (Low, Medium, or High), the page number and heading where the passage was found, and a text excerpt showing the flagged content in context.
Generate a PDF report#
Use --report to create a PDF report alongside the terminal output:
```
integritylens --report report.pdf document.pdf
```
The report contains the same findings as the terminal display, formatted for printing or sharing.

Refine the analysis#

Disable individual scanners or rules with --disable if a scanner produces too many false positives for a particular document:

integritylens --disable swiss-german document.pdf
integritylens --disable eszett document.pdf
integritylens --disable eszett --disable em-dash document.pdf

Language selection#

By default, Quadrant IntegrityLens analyses text as German (deu). Use --language to change the document language:

integritylens --language fra document.pdf

Language-independent scanners (Unicode characters, structural patterns) always run regardless of the selected language.

UI language#

Quadrant IntegrityLens automatically detects your operating system language and displays all terminal output, spinner messages, and PDF reports in that language. Currently supported: English and German.

You can override the auto-detection with --ui-language:

integritylens --ui-language de document.pdf

`--language` controls which document language scanners are used (e.g., German umlaut detection). `--ui-language` controls the display language of the program itself. The two are independent.

Forcing OCR#

Quadrant IntegrityLens automatically detects whether a PDF has a usable text layer. If the text layer is broken (common with LaTeX PDFs), it falls back to OCR automatically. You can force OCR with:

integritylens --force-ocr document.pdf

This is slower (~25 seconds) but may produce better results for some documents.

All flags#

Flag	Alias	Environment variable	Description
`--disable`	`-d`	`INTEGRITYLENS_DISABLE`	Scanner or rule IDs to disable (repeatable)
`--report`	`-r`	`INTEGRITYLENS_REPORT`	Path for PDF report output
`--verbose`	`-v`	`INTEGRITYLENS_VERBOSE`	Show section text for each finding
`--log-level`		`INTEGRITYLENS_LOG_LEVEL`	Log verbosity: `debug`, `info`, `warn`, `error` (default: `warn`)
`--language`	`-l`	`INTEGRITYLENS_LANGUAGE`	ISO 639-3 language code (default: `deu`)
`--ui-language`		`INTEGRITYLENS_UI_LANGUAGE`	UI display language: `en`, `de` (default: auto-detect)
`--force-ocr`		`INTEGRITYLENS_FORCE_OCR`	Always use OCR, skip automatic detection

Every flag can also be set via its corresponding INTEGRITYLENS_ environment variable.