Unified linting, formatting, and testing for polyglot projects.
01
Getting Started
hub — Welcome to the Lintro documentation! This hub provides comprehensive guides for using, configuring, and contributing to Lintro. > **Quick Start**: If you're new to Lintro, start with the [main README]
getting started — This guide will help you get up and running with Lintro quickly. Whether you're a new user or looking to integrate Lintro into your project, this guide covers everything you
02
Usage
usage — Guides for configuring Lintro, running in containers, integrating with CI, and extending the CLI.
configuration — This guide covers all configuration options for Lintro and the underlying tools it integrates. Learn how to customize behavior, set tool-specific options, and optimize
docker — This guide explains how to use Lintro with Docker for containerized development and CI environments.
github — This guide explains how to set up Lintro with GitHub Actions for automated code quality checks, coverage reporting, and CI/CD integration.
ai features — Lintro includes optional AI-powered features that provide actionable insights and interactive fix suggestions on top of standard linting results. > **Requirements:** Python package extra + an API key.
ai transports — Lintro's AI review can run on two transports. Their timeouts, cost caps, failure modes, and reported numbers mean different things. Configure them under `ai.transports.*`
troubleshooting — This guide covers common issues and their solutions when using Lintro.
debugging — This guide explains how to use Lintro's logging system to diagnose issues.
plugins — This guide explains how to create **third-party tool plugins** for Lintro. A plugin is a normal Python package published to PyPI (or installed from anywhere) that adds one or
Library API — Lintro exposes a small, stable Python API for embedding checks, formatting, and tests in your own programs. ```python from lintro.api import check, fmt, test result = check(paths=['src'], tools='ruff'
03
Tools
tools — This directory contains comprehensive analyses comparing Lintro's wrapper implementations with the core tools themselves.
overview — This directory contains the foundational documents that guide Lintro's development.
vision — This document defines the long-term vision, mission, and guiding principles for the Lintro project. It serves as the north star for all development decisions.
architecture — This document describes the technical architecture of Lintro, including design decisions, component relationships, and guidelines for future development.
roadmap — This document outlines the prioritized improvements and features for Lintro. Items are organized by priority and grouped into logical phases.
AI Effective Config and Review Execution — This page is the architecture index for Lintro's AI review execution seams. The normative decision record is [ADR-0006](../adr/0006-ai-effective-config-and-review-execution.md) (epic
05
Security
security — Security assurance artifacts and requirements for the Lintro project.
assurance — This assurance note explains how `py-lintro` meets its documented security requirements and provides pointers to evidence.
requirements — This document summarizes security requirements adopted by `py-lintro` to support OpenSSF Best Practices (Silver).
06
Contributing
contributing — Thank you for your interest in contributing to Lintro! This document provides guidelines and information for contributors.
style guide — This document outlines the coding standards and best practices for the Lintro project.
self-use — This document explains how the Lintro project uses Lintro itself for code quality assurance. This demonstrates the tool's capabilities and ensures we maintain high code
shell scripts — This guide establishes standards for shell scripts in the lintro project to ensure consistency, reliability, and maintainability.