Documentation · LegacyLint

Quick Start Guide

Get up and running with LegacyLint in minutes.

1. Install

Download the native CLI for your OS. No .NET SDK required.

$ curl -fL -H "X-LegacyLint-Key: $LEGACYLINT_API_KEY" -o legacylint.zip https://api.legacylint.com/api/downloads/cli/linux-x64
$ unzip legacylint.zip && chmod +x legacylint

Optionally, run a scan to verify installation. Your project's API key (shown when you create a project) authorizes the scanner.

$ ./legacylint scan path/to/source --api-key $LEGACYLINT_API_KEY

2. Scan a project

Point the scanner at a source directory. Delphi, Free Pascal and VB6 files are picked up together.

$ ./legacylint scan ./src --api-key $LEGACYLINT_API_KEY

Scan: MyApp
Files: 2,184  |  Rules: 145  |  Duration: 17.0s
Issues:

                                - Critical: 14 | High: 62 | Medium: 204
Quality Score: 72/100 (+4 since last scan)
                            
Top issues:
- Unit cyclic dependency (3)
- Empty exception handlers (Critical)
Example report: See detailed issue list online...

3. Baseline

Record your starting point so new regressions can be measured. This prevents getting burdened by existing issues: record the baseline once, then gate later scans against it.

$ ./legacylint scan ./src --api-key $LEGACYLINT_API_KEY --write-baseline legacylint-baseline.json
$ ./legacylint scan ./src --api-key $LEGACYLINT_API_KEY --baseline legacylint-baseline.json --fail-on error

4. Enforce budgets in CI

Run LegacyLint as part of your CI pipeline. Require new issues to be fixed by enforcing budgets.