Skip to main content

A unified CLI tool for code formatting, linting, and quality assurance

Project description

Lintro

Lintro Logo

A comprehensive CLI tool that unifies various code formatting, linting, and quality assurance tools under a single command-line interface.

Tests CI Docker Coverage

Release PyPI Python License

CodeQL OpenSSF Scorecard OpenSSF Best Practices SBOM SBOM Status

๐Ÿš€ Quick Start

uv pip install lintro              # Install (or: pip install lintro)
lintro check .                     # Find issues (alias: chk)
lintro format .                    # Fix issues (alias: fmt)
lintro check --output-format grid  # Beautiful output

โœจ Why Lintro?

  • ๐ŸŽฏ Unified Interface - One command for all your linting and formatting tools
  • ๐Ÿ“Š Consistent Output - Beautiful, standardized output formats across all tools
  • ๐Ÿ”ง Auto-fixing - Automatically fix issues where possible
  • ๐Ÿณ Docker Ready - Run in isolated containers for consistent environments
  • ๐Ÿ“ˆ Rich Reporting - Multiple formats: grid, JSON, HTML, CSV, Markdown
  • โšก Fast - Optimized parallel execution

๐Ÿ”Œ Works With Your Existing Configs

Lintro respects your native tool configurations. If you have a .prettierrc, pyproject.toml [tool.ruff], or .yamllint, Lintro uses them automatically - no migration required.

  • Native configs are detected - Your existing .prettierrc, .oxlintrc.json, etc. work as-is
  • Enforce settings override consistently - Set line_length: 88 once, applied everywhere
  • Fallback defaults when needed - Tools without native configs use sensible defaults

See the Configuration Guide for details on the 4-tier config system.

๐Ÿ› ๏ธ Supported Tools

ToolLanguageAuto-fixInstall
Linters
Actionlint โš™๏ธ GitHub Actions - GitHub Releases
Clippy ๐Ÿฆ€ Rust โœ… rustup component add clippy
Hadolint ๐Ÿณ Dockerfile - GitHub Releases
Markdownlint ๐Ÿ“ Markdown - bun add -g markdownlint-cli2
npm install -g markdownlint-cli2
Oxlint ๐ŸŸจ JS/TS โœ… bun add -g oxlint
npm install -g oxlint
pydoclint ๐Ÿ Python - ๐Ÿ“ฆ
ShellCheck ๐Ÿš Shell Scripts - brew install shellcheck
GitHub Releases
Yamllint ๐Ÿงพ YAML - ๐Ÿ“ฆ
Formatters
Black ๐Ÿ Python โœ… ๐Ÿ“ฆ
Oxfmt ๐ŸŸจ JS/TS โœ… bun add -g oxfmt
npm install -g oxfmt
Prettier ๐ŸŸจ JS/TS ยท ๐Ÿงพ JSON โœ… bun add -g prettier
npm install -g prettier
shfmt ๐Ÿš Shell Scripts โœ… brew install shfmt
GitHub Releases
rustfmt ๐Ÿฆ€ Rust โœ… rustup component add rustfmt
Lint + Format
Ruff ๐Ÿ Python โœ… ๐Ÿ“ฆ
SQLFluff ๐Ÿ—ƒ๏ธ SQL โœ… pipx install sqlfluff
Taplo ๐Ÿงพ TOML โœ… brew install taplo
GitHub Releases
Type Checkers
Astro ๐Ÿš€ Astro - bun add astro
npm install astro
Mypy ๐Ÿ Python - ๐Ÿ“ฆ
svelte-check ๐Ÿ”ฅ Svelte - bun add -D svelte-check
npm install -D svelte-check
TypeScript ๐ŸŸจ JS/TS - bun add -g typescript
npm install -g typescript
brew install typescript
vue-tsc ๐Ÿ’š Vue - bun add -D vue-tsc
npm install -D vue-tsc
Security
Bandit ๐Ÿ Python - ๐Ÿ“ฆ
Gitleaks ๐Ÿ” Secret Detection - brew install gitleaks
GitHub Releases
cargo-audit ๐Ÿฆ€ Rust - cargo install cargo-audit
cargo-deny ๐Ÿฆ€ Rust - cargo install cargo-deny
Semgrep ๐Ÿ”’ Multi-language - pipx install semgrep
pip install semgrep
brew install semgrep

๐Ÿ“ฆ = bundled with lintro โ€” no separate install needed
โšก Node.js tools support --auto-install to install dependencies automatically

๐Ÿ“ฆ Installation

Python 3.11+ is required. Check tool versions with lintro list-tools.

# PyPI (recommended)
uv pip install lintro        # or: pip install lintro

# Homebrew (macOS binary)
brew tap lgtm-hq/tap && brew install lintro-bin

# Docker (tools image - includes all external tools)
docker run --rm -v $(pwd):/code ghcr.io/lgtm-hq/py-lintro:latest check

# Docker (base image - minimal, no external tools)
docker run --rm -v $(pwd):/code ghcr.io/lgtm-hq/py-lintro:base check

See Getting Started for detailed installation options.

๐Ÿ’ป Usage

# Check all files (alias: chk)
lintro check .

# Auto-fix issues (alias: fmt)
lintro format .

# Grid output with grouping
lintro check --output-format grid --group-by file

# Run specific tools
lintro check --tools ruff,prettier,mypy

# Auto-install Node.js dependencies
lintro check --tools tsc --auto-install

# Exclude directories
lintro check --exclude "node_modules,dist,venv"

# List available tools
lintro list-tools

๐Ÿณ Docker

# Run from GHCR (tools image - recommended)
docker run --rm -v $(pwd):/code ghcr.io/lgtm-hq/py-lintro:latest check

# With formatting
docker run --rm -v $(pwd):/code ghcr.io/lgtm-hq/py-lintro:latest check --output-format grid

# Base image (minimal, no external tools)
docker run --rm -v $(pwd):/code ghcr.io/lgtm-hq/py-lintro:base check

๐Ÿ“š Documentation

Guide Description
Getting Started Installation, first steps, requirements
Configuration Tool configuration, options, presets
Docker Usage Containerized development
GitHub Integration CI/CD setup, workflows
Contributing Development guide, adding tools
Troubleshooting Common issues and solutions

Advanced: Tool Analysis ยท Architecture ยท Security

๐Ÿ”จ Development

# Clone and install
git clone https://github.com/lgtm-hq/py-lintro.git
cd py-lintro
uv sync --dev

# Run tests
./scripts/local/run-tests.sh

# Run lintro on itself
./scripts/local/local-lintro.sh check --output-format grid

๐Ÿค Community

๐Ÿ“„ License

MIT License - see LICENSE for details.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lintro-0.52.17.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lintro-0.52.17-py3-none-any.whl (475.5 kB view details)

Uploaded Python 3

File details

Details for the file lintro-0.52.17.tar.gz.

File metadata

  • Download URL: lintro-0.52.17.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lintro-0.52.17.tar.gz
Algorithm Hash digest
SHA256 89c38ae012a8943333fa04e9ebbc2068de90a2c9b66fbfc30b5811175ef26605
MD5 d75998720f700060b11de447ad78df34
BLAKE2b-256 7931bce208df4e37842edb47604e85a4d5785d12d0074a447bae61951b29f20d

See more details on using hashes here.

Provenance

The following attestation bundles were made for lintro-0.52.17.tar.gz:

Publisher: publish-pypi-on-tag.yml on lgtm-hq/py-lintro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lintro-0.52.17-py3-none-any.whl.

File metadata

  • Download URL: lintro-0.52.17-py3-none-any.whl
  • Upload date:
  • Size: 475.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lintro-0.52.17-py3-none-any.whl
Algorithm Hash digest
SHA256 2fee37020699e1aa18051b05c6d4d48836dcef907d9285ac45700ec47b609785
MD5 04a7b4077b7cf9b1b6d1d568a4b36c76
BLAKE2b-256 42a2e546ad08aa5662245459b999f19a88fa3d905bc295fc99cfe728042390df

See more details on using hashes here.

Provenance

The following attestation bundles were made for lintro-0.52.17-py3-none-any.whl:

Publisher: publish-pypi-on-tag.yml on lgtm-hq/py-lintro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page