1
Install the CLI
First, install our CLI onto your local machine:Qlty CLI supports macOS and Linux on X64 and ARM64, with Windows support in development.
Alternative: Installing with verification
Alternative: Installing with verification
We provide GitHub attestations powered by Sigstore that allow you to verify the authenticity of the Qlty CLI before installing it.Prerequisites: GitHub CLI (For other platforms, download the appropriate archive from GitHub releases.Learn more: GitHub artifact attestations documentation
gh) must be installed.Example (macOS Apple Silicon):2
Initialize your repository
From your Git repository, run:This will generate a baseline configuration based on the file types within your project and store it as
bash
.qlty/qlty.toml in your repository.You can find more plugins with qlty plugins list and enable them with qlty plugins enable [plugin].3
Identify code smells and review quality metrics
Check the code quality (for supported programming languages):
Scan for code smells like duplication
Review a summary of quality metrics
4
Lint your project
Run linters on changed files on your current branch
Run linters on all files
Run only the shellcheck linter on all files
Run linters on the web/ folder
5
Auto-format your code
Auto-format changed files on your current branch
Auto-format files in a directory
Getting help
- Learn more: Run
qltyfor a summary of the most commonly used commands andqlty --helpfor a full list.- Appending
--helpto any command will provide detailed information about that command.
- Appending
- Join the community: Chat with us on Discord
- Get community support: Open an issue or discussion on GitHub
Next steps
- Exclude irrelevant files in your repository
- Refer to the Analysis Configuration guide
- Explore the 40+ linters and security scanners available as plugins
