<!-- markdownlint-disable MD013 MD033 MD041 --> <!-- header-intro-start --> <!-- header-intro-end --> <!-- header-logo-start --> <div align="center"> <a href="https://megalinter.io" target="blank" title="Visit MegaLinter Web Site"> <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/megalinter-banner.png" alt="MegaLinter" min-height="200px"> </a> </div> <!-- header-logo-end --> <!-- mega-linter-title-start -->

MegaLinter, by

<!-- mega-linter-title-end --> <!-- mega-linter-badges-start -->

<!-- gh-dependents-info-used-by-start -->

<!-- gh-dependents-info-used-by-end -->

<!-- mega-linter-badges-end --> <!-- welcome-phrase-start -->

MegaLinter is an open-source tool for CI/CD workflows that analyzes the consistency of your code, IaC, configuration, and scripts in your repository to ensure all your project sources are clean and formatted, no matter which IDE or toolbox is used by your developers. Powered by OX Security.

Supports 69 languages, 23 formats, 21 tooling formats, and is ready to use out of the box as a GitHub Action or with any CI system. It is highly configurable and free for all uses.

MegaLinter has native integrations with many major CI/CD tools.

<!-- welcome-phrase-end -->

Upgrade to MegaLinter v9 :):

• Use the new LLM Advisor that will tell you how to fix linters issues
• Create your own MegaLinter Custom Flavors to improve performance

<!-- online-doc-start -->

Before you go further, see the online documentation website, which offers much easier navigation than this README

<!-- online-doc-end --> <!-- table-of-contents-start -->

Table of Contents

• Why MegaLinter
• Quick Start
• Supported Linters
  • Languages
  • Formats
  • Tooling formats
  • Other
• Installation
  • Assisted installation
  • Which version to use ?
  • GitHub Action
  • GitLab CI
  • Azure Pipelines
    • Single Repository
    • Central Repository
    • Pull Request Comments
    • Detailed Tutorial
  • Bitbucket Pipelines
  • Jenkins
  • Concourse
    • Pipeline step
    • Use it as a reusable task
  • Drone CI
    • (Optional) Adjusting trigger rules
  • Docker container
  • Run MegaLinter locally
• Configuration
  • .mega-linter.yml file
  • Common variables
  • Activation and deactivation
  • Filter linted files
  • Apply fixes
    • Apply fixes issues
    • Notes
  • Linter specific variables
  • Pre-commands
  • Post-commands
  • Environment variables security
    • Secured env variables
    • Secured configuration examples
    • Default secured variables
    • Unhide variables for linters
  • CLI lint mode
• Reporters
• Flavors
• Badge
  • Markdown
  • reStructuredText
• Plugins
  • External Plugins Catalog
  • Use external plugins
    • Example
  • Create your own plugin
    • Limitations
• They talk about MegaLinter
  • English articles
  • French articles
  • Videos
  • Web Sites
  • Linters
• Frequently Asked Questions
• How to contribute
• Special thanks
  • Maintainers
  • Contributors
  • Open-source teams
  • Super-Linter team
• License
• MegaLinter vs Super-Linter
  • Security
  • Performance
  • More languages and formats linted
  • Automatically apply formatting and fixes
  • Run locally
  • Reports
    • Capabilities
    • Additional Reporters
  • Enhanced configuration
  • Enhanced documentation
  • Plugin management
  • Simplify architecture and evolutionary maintenance
  • Improve robustness & stability

<!-- table-of-contents-end -->

Why MegaLinter

Projects need to contain clean code in order to avoid technical debt, which makes ongoing maintenance harder and more time-consuming.

By using [code formatters and code linters]