Guide · Open source
How to use Super-Linter: setup, runs and fixes
Updated · written with AI from the project's own documentation and checked against our catalogue data
Super-Linter is a ready-to-run collection of linters and code analyzers that checks source code for style and quality problems across many languages. This guide explains what it does, how to run it on GitHub Actions or in a container, and how to use its fix option. By the end you will know what you need installed, how to get the project, and where to look for the list of supported tools.
Super-Lintersuper-linter/super-linter · ★ 10.6k · MIT Install options & downloads Quick start
- 1Confirm your container runtime. Install Docker or another OCI-compatible container runtime if you plan to run Super-Linter standalone.
- 2Clone the repository. Run git clone https://github.com/super-linter/super-linter to download the project.
- 3Read the README setup section. Choose between GitHub Actions and running in a container outside GitHub Actions.
- 4Set up the GitHub Actions workflow. For pull request checks, follow the get-started section and add the workflow to your repository.
- 5Run the linters. Trigger a run and read the results in the console output or as status checks on your pull request.
- 6Fix what can be fixed. Use the fix section of the README to apply automatic fixes to supported formatting issues, then review the changes.
What Super-Linter does
Super-Linter analyzes source code files using several tools. It reports the issues those tools find as console output and as GitHub Actions status checks.
The goal is to help you establish consistent formatting across multiple programming languages and to check that developers follow those conventions. It can also help fix some linting and formatting issues.
- Reports issues in the console and as GitHub Actions status checks
- Runs the included linters in parallel
- Can fix some linting and formatting issues
- Licensed under the MIT License
Check the requirements before you start
The main dependency is an OCI-compatible container runtime engine, such as Docker. Super-Linter runs on GitHub Actions or in other environments, and the README describes both paths.
Standalone use needs Docker or another OCI-compatible container runtime. You do not need to install each linter on your machine separately.
- GitHub Actions: no local runtime needed for the workflow itself
- Standalone: Docker or another OCI-compatible container runtime
Get the Super-Linter source
The README lists cloning the repository as the first install step. Run the command below in a terminal to download the project files to your machine.
Check the README in the cloned repository for the current steps to run it, since the sections on GitHub Actions and container runtimes are the documented entry points.
git clone https://github.com/super-linter/super-linterRun Super-Linter on GitHub Actions
Super-Linter runs on GitHub Actions and reports results as status checks on pull requests. This is the setup most teams use to keep code consistent without wiring up each tool separately.
The README links to the GitHub Marketplace listing for the action. Follow the get-started section of the README for the workflow setup.
- Results appear as GitHub Actions status checks
- Useful for enforcing conventions on every pull request
Run Super-Linter in a container outside GitHub Actions
To run it elsewhere, use a container runtime. The README describes running Super-Linter outside GitHub Actions as a supported path, with Docker as the example engine.
Because the tools run inside the container, you avoid installing each linter locally. Use this route if your project is not hosted on GitHub.
- Requires Docker or another OCI-compatible container runtime
- Keeps linter installs out of your local environment
Fix linting and formatting issues
Super-Linter can help fix some issues, not all. The README links to a dedicated section on fixing linting and formatting issues, which describes how this works.
Review any automatic changes before committing them, so you know exactly what was altered in your files.
- Fixes apply to some issues only
- Check the fix section of the README for configuration details
What people use it for
- Blocking pull requests that break agreed formatting rules in a GitHub repository
- Running one linting entry point across a project that mixes several programming languages
- Checking code in a container so contributors do not install each linter locally
- Enforcing consistent formatting conventions in continuous integration
Frequently asked questions
Is Super-Linter free to use?
Super-Linter is licensed under the MIT License, which the README links to. Check the LICENSE file in the repository for the full terms.
What do I need to install Super-Linter?
For standalone use, you need Docker or another OCI-compatible container runtime. On GitHub Actions, the README describes running it as an action without a local install of each tool.
Does Super-Linter work outside GitHub?
The README describes running it outside GitHub Actions in a container runtime environment. Projects not hosted on GitHub or not using a container runtime may find it less suitable.
Can Super-Linter fix my code automatically?
Yes, it can help fix some linting and formatting issues. It does not fix every issue, so review its changes before you commit them.
What are alternatives to Super-Linter?
Comparable projects include Trunk, MegaLinter and Qodana. Pick based on your languages, hosting setup and how much tooling you want bundled.
Why does Super-Linter feel heavy for a small project?
It bundles many linters and analyzers, so it may be heavier than needed if you only want one language-specific linter. A single tool may be a better fit in that case.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Super-Linter suits teams that want automated checks on GitHub pull requests or one linting entry point across several languages, especially if they prefer running tools in a container. If your project is not on GitHub, does not use a container runtime, or needs only one language's linter, consider a lighter alternative such as one of the comparable projects.
Install options & downloads