Repository files navigation

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 iscompletely free for all use, including for commercial projects, with no limits on contributors.

• ✨ 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

💡 Learn more in theDocumentation.

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

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

# Install on MacOS or Linuxcurl https://qlty.sh| bash# Install on Windowspowershell -c"iwr https://qlty.sh | iex"

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

Setup Qlty within a Git repository:

cd my_repo/qlty init

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

Read our documentation aboutconfiguration for more information.

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 pluginsenable<NAME>

Thefull list of plugins is available on GitHub.

The Qlty CLI calculates a variety of code quality metrics which are available through theqlty metrics subcommand and as trends onQlty Cloud.

Quality metrics are available for C#, Go, Java, JavaScript, Kotlin, PHP, Python, Ruby, Rust, and TypeScript.

Qlty CLI is available for MacOS, Linux, and Windows on x86 and ARM platforms.

Certain PHP linters require a working installation of PHP available in your$PATH. To install PHP, useHomebrew or an alternative method.

• Read thedocumentation
• Join ourDiscord chat
• Community support via GitHub Discussions
• Feature requests via GitHub Discussions
• Bug reports via GitHub Issues
• Plugin request via GitHub Issues

Creating a plugin can be as easy as writing a small plugin definition TOML file. If the tool has a custom output format (instead of a standard likeSARIF), then writing a simple output parser in Rust is also needed.

We also happily accept requests for new plugins viaGitHub issues.

Developing on Qlty CLI requires a workingRust toolchain and adheres to the standard Rust development process:

git clone https://github.com/qltysh/qlty.gitcd qltycargo buildcargotest

More information about how to contribute can be found in CONTRIBUTING.md.

Reports of security vulnerabilities should be handled with the process outlined in SECURITY.md.

Qlty CLI is published under aFair Source license. As Fair Source, the Qlty CLI is free to use (including in commercial contexts), modify, and distribute in accordance with its license.

This code is made available under the Business Source License 1.1 (BSL) and transitions into Open Source via a Delayed Open Source Publication (DOSP). More details are available in LICENSE.md.

We would like to thank all of the developers of code quality tooling like linters and meta-linters as well as everyone who has contributed to the field of open source static analysis. Qlty CLI stands on the shoulders of decades of this excellent work.

Licenses for code incorporated into Qlty CLI can be found in the docs/licenses folder.