Qlty

<div align="left" id="top"> <a href="https://qlty.sh"><img alt="Qlty" src="https://cdn.brandfetch.io/idGrC4YgF4/theme/dark/idPHbenxLP.svg?c=1bxid64Mup7aczewSAYMX&t=1734797742010" height="75"></a> </div>

Universal linting, auto-formatting, maintainability, and security scanning

Qlty CLI is a multi-language code quality tool for linting, auto-formatting, maintainability, and security with support for 70+ static analysis tools for 40+ languages and technologies.

With Qlty CLI, polyglot team can take advantage of the best code quality static analysis with fast, consistent, and unified results through a single tool. Configuration is done through a simple .qlty/qlty.toml file in your repository, which can be auto-generated based on the languages you use.

The Qlty CLI is completely free for all use, including for commercial projects, with no limits on contributors.

---

📖 Table of Contents

• ✨ Key Features
• 🚀 Quick Start
  • 📦 Installation
  • Setting up Qlty in a new repository
  • Usage
  • Configuration
• 🧹 Available Linters
• 📊 Code Quality Metrics
• 🖥️ System Requirements
• 🛟 Help or Feedback
• 🧑‍💻 Contributing
• ⚖️ License

---

✨ Key Features

What We Do

| | Feature | Advantage | | --- | ----------------- | ---------------------------------------------------- | | 🐛 | Linting | Comprehensive language support in one tool | | 🖌️ | Auto-formatting | Consistent code style everywhere | | 💩 | Maintainability | Code smells like copy-paste detection and complexity | | 🚨 | Security scanning | SAST, SCA, secret detection, IaC analysis, and more | | 🚦 | Code coverage | Total coverage and diff coverage | | 📊 | Quality metrics | Complexity, duplication, LOC, etc. |

How We Do It

| | Feature | Advantage | | --- | ----------------------- | --------------------------------------------------------------------------- | | 🌲 | Git-aware | Focus on newly introduced quality issues | | ⚡ | Auto-initialization | Get up and running in two minutes | | ✅ | Autofixes | Including tool-generated and AI-generated fixes | | ⚙️ | Config as code | Version controlled with maximum flexibility | | 🏎️ | Caching and concurrency | The absolute fastest way to run static analysis | | 🪝 | Git hooks | Integrate with pre-commit and pre-push hooks | | 🤖 | Pull request reviews | Automated feedback in comments and statuses | | 🌐 | Runs anywhere | Mac, Linux, and Windows with no dependency on Docker | | 🦀 | Written in Rust | Fast execution and easy to contribute | | 🎁 | 100% free | Including for commercial projects, with no contributor limits | | ⚖️ | Fair Source | Public on GitHub with delayed open source publication (DOSP). PRs accepted! |

💡 Learn more in the Documentation.

Qlty Software: Code quality and coverage done right

Qlty CLI is part of Qlty Software's comprehensive platform for code quality. Bring code quality into every step of your software development workflow with:

• Qlty CLI -- Polyglot code quality CLI written in Rust
• Qlty Cloud -- Automated code review and quality trends
• Visual Studio Code Extension -- Linting and auto-formatting in your IDE
• GitHub Action -- Run Qlty CLI within your CI workflows
• Chrome and Firefox Extension -- Adds code coverage data to GitHub.com

---

🚀 Quick Start

Installation

The fastest way to install Qlty CLI is using our installer scripts which install our native binaries:

# Install on MacOS or Linux
curl https://qlty.sh | bash


# Install on Windows
powershell -c "iwr https://qlty.sh | iex"

We also package the CLI as a Docker image on GitHub Container Registry (GHCR).

[!NOTE] The Qlty CLI does not use Docker to run linters. By running linters natively, we achieve maximum performance. The Docker image is provided for situations where running the CLI as a containers is preferred over running it as a native binary.

Setting up Qlty in a new repository

Setup Qlty within a Git repository:

cd my_repo/
qlty init

Usage

| Example Command | Description | | ---------------------------------------------------- | ---------------------------------------- | | qlty init | Setup Qlty within a Git repository | | qlty check --sample=5 | View a sample of lint issues | | qlty fmt --all | Auto-format the codebase | | qlty smells --all | Scan for code smells like duplication | | qlty metrics --max-depth=2 --sort complexity --all | Review a summary of code quality metrics |

Configuration

Qlty CLI is configured using a .qlty/qlty.toml file in your Git repository. You can generate a default configuration with qlty init and then customize it.

Read our documentation about configuration for more information.

---

🧹 Available Linters

Over 20,000 code quality rules are available via the Qlty CLI through its 60+ linter plugins.

To enable new plugins by adding them to your .qlty/qlty.toml file run:

qlty plugins enable <NAME>

| Technology | Available code quality tools | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | All files | ast-grep, gitleaks, ripgrep, semgrep, trivy, trufflehog, vale | | Apex | pmd | | C# | complexity, duplication | | C/C++ | osv-scanner, trivy