megalinter
๐ฆ MegaLinter analyzes 50 languages, 22 formats, 21 tooling formats, excessive copy-pastes, spelling mistakes and security issues in your repository sources with a GitHub Action, other CI tools or locally.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026. Its scripts were only partly scanned.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/oxsecurity/megalinter with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/oxsecurity/megalinter'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/oxsecurity--megalinter)HTML
<a href="/listings/oxsecurity--megalinter"><img src="/api/listings/oxsecurity--megalinter/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
- **With a coding agent**: install the [MegaLinter agent skills](https://megalinter.io/latest/install-agent-skills/) with `npx skills add oxsecurity/megalinter/skills`, then ask your agent to _"setup megalinter"_. - **Or with the interactive wizard**: run `npx mega-linter-runner --install` to generate configuration files (you need [Node.js](https://nodejs.org/en/) installed). - Commit, push, and create a pull request. - Watch!
**Notes**:
- This repo is a hard fork of [GitHub Super-Linter](https://github.com/super-linter/super-linter), rewritten in Python to add [many additional features](#mega-linter-vs-super-linter). - If you are a Super-Linter user, you can transparently **switch to MegaLinter and keep the same configuration** (just replace `super-linter/super-linter@v3` with `oxsecurity/megalinter@v10` in your GitHub Action YAML file, [like on this PR](https://github.com/nvuillam/npm-groovy-lint/pull/109)). - If you want to use MegaLinter's extra features (recommended), please take 5 minutes to use the [assisted installation](https://github.com/oxsecurity/megalinter/tree/main/docs/install-assisted.md). - For a beginner-friendly example of getting started with MegaLinter, check out [this blog post](https://ayyjohn.com/posts/linting-a-jekyll-blog-with-mega-linter) by Alec Johnson.
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
.claude-plugin/marketplace.json ยท Manifest ยท 26 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- {
- "name": "megalinter",
- "owner": {
- "name": "OX Security",
- "url": "https://github.com/oxsecurity"
- },
- "description": "MegaLinter agent plugin: set up, run and fix MegaLinter from your coding agent.",
- "plugins": [
- {
- "name": "megalinter",
- "source": "./",
- "description": "Set up, run and fix MegaLinter on any repository: 100+ linters for 69+ languages, 23+ formats and 21+ tooling formats, from CI or locally.",
- "category": "code-quality",
- "homepage": "https://megalinter.io",
- "repository": "https://github.com/oxsecurity/megalinter",
- "license": "AGPL-3.0",
- "keywords": [
- "linter",
- "code-quality",
- "formatter",
- "security",
- "ci"
- ]
- }
- ]
- }
README.md ยท README ยท 1,354 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <!-- 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 [](https://www.ox.security/?ref=megalinter)
- <!-- mega-linter-title-end -->
- <!-- mega-linter-badges-start -->
- 
- [](https://megalinter.io/flavors/)
- [](https://npmjs.org/package/mega-linter-runner)
- [](https://megalinter.io/latest/coding-agents/)
- [](https://github.com/oxsecurity/megalinter/stargazers/)
- [](https://github.com/oxsecurity/megalinter/actions?query=workflow%3AMegaLinter+branch%3Amain)
- [](https://codecov.io/gh/oxsecurity/megalinter)
- <!-- gh-dependents-info-used-by-start -->
- [](https://github.com/oxsecurity/megalinter/blob/main/./docs/used-by-stats.md)<!-- gh-dependents-info-used-by-end -->
- [](https://github.com/aquasecurity/trivy)
- [](https://github.com/oxsecurity/megalinter/graphs/contributors/)
- [](https://github.com/sponsors/nvuillam)
- [](https://github.com/oxsecurity/megalinter/blob/main/.github/CONTRIBUTING.md)
- [](https://twitter.com/intent/tweet?text=Check+MegaLinter+to+say+goodbye+to+dirty+code+in+your+projects+%3A%29+100%25+free+and+open+source+for+all+uses&url=https://megalinter.io/&via=NicolasVuillamy&hashtags=linters,code,quality,ci,python,java,golang,c,dotnet,kotlin,rust,scala,salesforce,terraform)
- <!-- 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**](https://www.ox.security/?ref=megalinter).
- Supports [**68** languages](#languages), [**23** formats](#formats), [**22** tooling formats](#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 popular CI/CD tools and is compliant with most [**Coding Agents**](https://megalinter.io/latest/coding-agents/).
- <div align="center">
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/GitHubCommentReporter.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/github.png?raw=true" alt="GitHub" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/GitlabCommentReporter.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/gitlab.png?raw=true" alt="GitLab" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/AzureCommentReporter.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/azure.png?raw=true" alt="Azure" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/BitbucketCommentReporter.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/bitbucket.png?raw=true" alt="Bitbucket" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/install-jenkins.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/jenkins.png?raw=true" alt="Jenkins" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/install-drone.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/drone.png?raw=true" alt="Drone" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/install-concourse.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/concourse.png?raw=true" alt="Concourse" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/install-docker.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/docker.png?raw=true" alt="Docker" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/SarifReporter.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/sarif.png?raw=true" alt="SARIF" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/observability/grafana.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/grafana.png?raw=true" alt="Grafana" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/observability/datadog.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/datadog.png?raw=true" alt="Datadog" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/observability/newrelic.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/newrelic.png?raw=true" alt="New Relic" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/observability/elastic.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/integrations/elastic.png?raw=true" alt="Elastic" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- </div>
- <div align="center">
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/claude.png?raw=true" alt="Claude Code" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/cursor.png?raw=true" alt="Cursor" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/github-copilot.png?raw=true" alt="GitHub Copilot CLI" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/codex.png?raw=true" alt="Codex" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/antigravity.png?raw=true" alt="Antigravity" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/opencode.png?raw=true" alt="OpenCode" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/gemini-cli.png?raw=true" alt="Gemini CLI" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/windsurf.png?raw=true" alt="Windsurf" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/cline.png?raw=true" alt="Cline" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/roo-code.png?raw=true" alt="Roo Code" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/kilo-code.png?raw=true" alt="Kilo Code" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/amp.png?raw=true" alt="Amp" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/goose.png?raw=true" alt="Goose" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/openhands.png?raw=true" alt="OpenHands" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- <a href="https://github.com/oxsecurity/megalinter/tree/main/docs/coding-agents.md"><img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/qwen-code.png?raw=true" alt="Qwen Code" height="40" style="height:40px;vertical-align:middle;margin:4px"></a>
- </div>
- <!-- welcome-phrase-end -->
- 
- - Use the new [LLM Advisor](https://megalinter.io/latest/llm-advisor/) that will tell you how to fix linters issues
- - Create your own [MegaLinter Custom Flavors](https://megalinter.io/latest/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**](https://megalinter.io/)
- <!-- online-doc-end -->
- <!-- table-of-contents-start -->
- ## Table of Contents
- - [Why MegaLinter](#why-megalinter)
- - [Quick Start](#quick-start)
- - [Coding Agents](#coding-agents)
- - [Supported Linters](#supported-linters)
- - [Languages](#languages)
- - [Formats](#formats)
- - [Tooling formats](#tooling-formats)
- - [Other](#other)
- - [Installation](#installation)
- - [Coding agents (skills)](#coding-agents-skills)
- - [Coding Agents (Plugins)](#coding-agents-plugins)
- - [Assisted installation](#assisted-installation)
- - [Which version to use ?](#which-version-to-use-)
- - [GitHub Action](#github-action)
- - [GitLab CI](#gitlab-ci)
- - [Azure Pipelines](#azure-pipelines)
- - [Single Repository](#single-repository)
- - [Central Repository](#central-repository)
- - [Pull Request Comments](#pull-request-comments)
- - [Detailed Tutorial](#detailed-tutorial)
- - [Bitbucket Pipelines](#bitbucket-pipelines)
- - [Jenkins](#jenkins)
- - [Concourse](#concourse)
- - [Pipeline step](#pipeline-step)
- - [Use it as a reusable task](#use-it-as-a-reusable-task)
- - [Drone CI](#drone-ci)
- - [(Optional) Adjusting trigger rules](#optional-adjusting-trigger-rules)
- - [Docker container](#docker-container)
- - [Run MegaLinter locally](#run-megalinter-locally)
- - [Configuration](#configuration)
- - [.mega-linter.yml file](#mega-linteryml-file)
- - [Common variables](#common-variables)
- - [Activation and deactivation](#activation-and-deactivation)
- - [Filter linted files](#filter-linted-files)
- - [Apply fixes](#apply-fixes)
- - [Apply fixes issues](#apply-fixes-issues)
- - [Notes](#notes)
- - [Linter specific variables](#linter-specific-variables)
- - [Pre-commands](#pre-commands)
- - [Post-commands](#post-commands)
- - [Environment variables security](#environment-variables-security)
- - [Secured env variables](#secured-env-variables)
- - [Secured configuration examples](#secured-configuration-examples)
- - [Default secured variables](#default-secured-variables)
- - [Unhide variables for linters](#unhide-variables-for-linters)
- - [CLI lint mode](#cli-lint-mode)
- - [Reporters](#reporters)
- - [Flavors](#flavors)
- - [Badge](#badge)
- - [Markdown](#markdown)
- - [reStructuredText](#restructuredtext)
- - [Plugins](#plugins)
- - [External Plugins Catalog](#external-plugins-catalog)
- - [Use external plugins](#use-external-plugins)
- - [Example](#example)
- - [Create your own plugin](#create-your-own-plugin)
- - [Limitations](#limitations)
- - [They talk about MegaLinter](#they-talk-about-megalinter)
- - [English articles](#english-articles)
- - [French articles](#french-articles)
- - [Videos](#videos)
- - [Web Sites](#web-sites)
- - [Linters](#linters)
- - [Frequently Asked Questions](#frequently-asked-questions)
- - [How to contribute](#how-to-contribute)
- - [Special thanks](#special-thanks)
- - [Maintainers](#maintainers)
- - [Contributors](#contributors)
- - [Open-source teams](#open-source-teams)
- - [Super-Linter team](#super-linter-team)
- - [License](#license)
- - [MegaLinter vs Super-Linter](#megalinter-vs-super-linter)
- - [Security](#security)
- - [Performance](#performance)
- - [More languages and formats linted](#more-languages-and-formats-linted)
- - [Automatically apply formatting and fixes](#automatically-apply-formatting-and-fixes)
- - [Run locally](#run-locally)
- - [Reports](#reports)
- - [Capabilities](#capabilities)
- - [Additional Reporters](#additional-reporters)
- - [Enhanced configuration](#enhanced-configuration)
- - [Enhanced documentation](#enhanced-documentation)
- - [Plugin management](#plugin-management)
- - [Simplify architecture and evolutionary maintenance](#simplify-architecture-and-evolutionary-maintenance)
- - [Improve robustness \& stability](#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**](#supported-linters), you ensure that your **codebase is easier to read** and **follows best practices**, from kickoff through each step of the project lifecycle.
- Not all developers use linters in their IDEs, which makes code reviews harder and longer to process.
- By using **MegaLinter**, you'll enjoy the following benefits for your team:
- - At **each pull request**, it **automatically analyzes all updated code across all languages**.
- - By reading error logs, **developers learn best practices** for the languages they use.
- - The [**MegaLinter documentation**](https://megalinter.io/) provides a **list of IDE plugins for each linter**, so developers know which linter and plugins to install.
- - MegaLinter **works out of the box** after a [**quick setup**](#quick-start).
- - **Formatting and fixes** can be automatically [**applied directly to the Git branch**](https://github.com/oxsecurity/megalinter/tree/main/docs/config-apply-fixes.md) or [**provided in reports**](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/UpdatedSourcesReporter.md).
- - This tool is **100% open source** and **free for all uses** (personal, professional, public, and private repositories).
- - MegaLinter can run on [**any CI tool**](https://github.com/oxsecurity/megalinter/tree/main/docs/install-assisted.md) and be [**run locally**](https://megalinter.io/mega-linter-runner/): **no need to authorize an external application**, and **your codebase never leaves your tooling ecosystem**.
- Join a **continuously growing community**: MegaLinter Docker images are pulled **hundreds of thousands of times every month**.
- [](https://megalinter.io/latest/flavors-stats/)
- <!-- quick-start-section-start -->
- <!-- markdown-headers
- ---
- title: Quick Start with MegaLinter
- description: Setup MegaLinter in 5 minutes thanks to its assisted installation tool
- ---
- -->
- ## Quick Start
- - **With a coding agent**: install the [MegaLinter agent skills](https://megalinter.io/latest/install-agent-skills/) with `npx skills add oxsecurity/megalinter/skills`, then ask your agent to _"setup megalinter"_.
- - **Or with the interactive wizard**: run `npx mega-linter-runner --install` to generate configuration files (you need [Node.js](https://nodejs.org/en/) installed).
- - Commit, push, and create a pull request.
- - Watch!
- 
- **Notes**:
- <!-- # MAJOR-RELEASE-IMPACTED -->
- - This repo is a hard fork of [GitHub Super-Linter](https://github.com/super-linter/super-linter), rewritten in Python to add [many additional features](#mega-linter-vs-super-linter).
- - If you are a Super-Linter user, you can transparently **switch to MegaLinter and keep the same configuration** (just replace `super-linter/super-linter@v3` with `oxsecurity/megalinter@v10` in your GitHub Action YAML file, [like on this PR](https://github.com/nvuillam/npm-groovy-lint/pull/109)).
- - If you want to use MegaLinter's extra features (recommended), please take 5 minutes to use the [assisted installation](https://github.com/oxsecurity/megalinter/tree/main/docs/install-assisted.md).
- - For a beginner-friendly example of getting started with MegaLinter, check out [this blog post](https://ayyjohn.com/posts/linting-a-jekyll-blog-with-mega-linter) by Alec Johnson.
- <!-- quick-start-section-end -->
- <!-- coding-agents-section-start -->
- <!-- markdown-headers
- ---
- title: Use MegaLinter with coding agents
- description: Setup, run and fix MegaLinter errors from Claude Code, Cursor, GitHub Copilot CLI, Codex, Gemini CLI, Antigravity, OpenCode and other coding agents, with token-efficient sub-agents orchestration
- ---
- -->
- ## Coding Agents
- MegaLinter is designed to work hand in hand with your coding agent:
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/claude.png?raw=true" alt="Claude Code" height="40" style="height:40px">](https://claude.com/product/claude-code)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/cursor.png?raw=true" alt="Cursor" height="40" style="height:40px">](https://cursor.com)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/github-copilot.png?raw=true" alt="GitHub Copilot CLI" height="40" style="height:40px">](https://github.com/features/copilot)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/codex.png?raw=true" alt="Codex" height="40" style="height:40px">](https://openai.com/codex/)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/antigravity.png?raw=true" alt="Antigravity" height="40" style="height:40px">](https://antigravity.google/)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/opencode.png?raw=true" alt="OpenCode" height="40" style="height:40px">](https://opencode.ai)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/gemini-cli.png?raw=true" alt="Gemini CLI" height="40" style="height:40px">](https://github.com/google-gemini/gemini-cli)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/windsurf.png?raw=true" alt="Windsurf" height="40" style="height:40px">](https://windsurf.com)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/cline.png?raw=true" alt="Cline" height="40" style="height:40px">](https://cline.bot)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/roo-code.png?raw=true" alt="Roo Code" height="40" style="height:40px">](https://roocode.com)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/kilo-code.png?raw=true" alt="Kilo Code" height="40" style="height:40px">](https://kilocode.ai)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/amp.png?raw=true" alt="Amp" height="40" style="height:40px">](https://ampcode.com)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/goose.png?raw=true" alt="Goose" height="40" style="height:40px">](https://block.github.io/goose/)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/openhands.png?raw=true" alt="OpenHands" height="40" style="height:40px">](https://www.all-hands.dev)
- [<img src="https://github.com/oxsecurity/megalinter/blob/main/docs/assets/icons/agents/qwen-code.png?raw=true" alt="Qwen Code" height="40" style="height:40px">](https://github.com/QwenLM/qwen-code)
- ### Get started
- Install the [MegaLinter agent skills](https://github.com/oxsecurity/megalinter/tree/main/skills) at the root of your repository:
- With **Claude Code** (the skills are copied directly into `.claude/skills/`):
- ```bash
- npx skills add oxsecurity/megalinter/skills -s '*' -a claude-code -y
- ```
- With **another coding agent**, replace `claude-code` with your agent's identifier (`cursor`, `github-copilot`, `codex`, `antigravity`, `opencode`... full list in the [skills CLI documentation](https://github.com/vercel-labs/skills#supported-agents)) โ or let the CLI **detect your installed agents** and install the skills for all of them at once:
- ```bash
- npx skills add oxsecurity/megalinter/skills -s '*' -y --copy
- ```
- Then just talk to your agent:
- - _"Setup MegaLinter on this repo"_
- - _"Run MegaLinter and fix the errors"_
- - _"Why is the MegaLinter CI job failing? Fix it"_
- ### What the skills do
- | Skill | Role |
- |:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- | **megalinter** | Entry point: detects the repository state and orchestrates the other skills in a check โ fix โ re-check loop (3 iterations max) |
- | **megalinter-setup** | Installs or upgrades MegaLinter using `npx mega-linter-runner --install` (non-interactive), then refines `.mega-linter.yml` |
- | **megalinter-check** | Collects errors: watches a MegaLinter CI job (GitHub Actions, GitLab CI, Azure Pipelines, Bitbucket Pipelines) or runs MegaLinter locally with docker/podman |
- | **megalinter-fix** | Fixes errors guided by a per-linter fix guide (one for each of the 124 linters, loaded only when its linter has errors), asks you before disabling rules or pushing |
- ### Sub-agents orchestration
- On agents supporting sub-agents (Claude Code, OpenCode, GitHub Copilot custom agents...), `megalinter-setup` installs three sub-agents that keep large CI logs and linter outputs **out of your main agent's context**, and run on low-cost models when possible:
- ```mermaid
- flowchart TD
- U(["๐ค You: <i>run megalinter and fix the errors</i>"]) --> O["๐ฏ megalinter<br/>(orchestrator skill)"]
- O -->|"no config found"| S["๐ ๏ธ megalinter-setup"]
- S -->|"npx mega-linter-runner --install"| CFG[/".mega-linter.yml<br/>+ CI workflow"/]
- O --> C["๐ megalinter-check"]
- C -->|"watch mode"| W[["๐ megalinter-watcher<br/>sub-agent, low-cost model"]]
- W --> CI[/"CI job logs<br/>GitHub / GitLab / Azure / Bitbucket"/]
- C -->|"local mode"| RUN[["๐ณ megalinter-runner<br/>sub-agent, low-cost model"]]
- RUN --> IMG[/"MegaLinter Docker image<br/>docker or podman"/]
- W --> ERR[/"๐ Compact error list<br/>grouped by linter"/]
- RUN --> ERR
- ERR --> F["๐ง megalinter-fix"]
- F -->|"one sub-agent per failing linter,<br/>in parallel"| FX1[["๐ค megalinter-fixer<br/>+ python_ruff fix guide"]]
- F --> FX2[["๐ค megalinter-fixer<br/>+ markdown_markdownlint fix guide"]]
- FX1 --> RES[/"โ๏ธ Fixed files<br/>+ proposed rule disables"/]
- FX2 --> RES
- RES -->|"you confirm disables"| RC["โป๏ธ Targeted re-check<br/>parallel standalone linter images"]
- RC -->|"errors remain (max 3 loops)"| F
- RC -->|"clean"| DONE(["โ Commit on a branch<br/>(never on main)"])
- classDef user fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px,color:#1b5e20
- classDef skill fill:#ede7f6,stroke:#5e35b1,stroke-width:2px,color:#311b92
- classDef subagent fill:#e3f2fd,stroke:#1976d2,stroke-width:2px,color:#0d47a1
- classDef artifact fill:#fff8e1,stroke:#f9a825,stroke-width:1px,color:#5d4037
- classDef recheck fill:#e0f2f1,stroke:#00897b,stroke-width:2px,color:#004d40
- class U,DONE user
- class O,S,C,F skill
- class W,RUN,FX1,FX2 subagent
- class CFG,CI,IMG,ERR,RES artifact
- class RC recheck
- ```
- The fix guides combine information generated from the [linter descriptors](https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors) (auto-fix support, rules documentation URLs, MegaLinter tuning variables) with curated fix, inline-disable and ignore instructions grounded in each linter's official documentation.
- ### Safety rules
- - Safe fixes are applied automatically; ambiguous ones are asked to you
- - Disabling a linter or a rule always requires your confirmation
- - Commits are never pushed to the default branch
- See also the [installation page for coding agents](https://megalinter.io/latest/install-agent-skills/), or install everything at once as an [agent plugin](https://megalinter.io/latest/agent-plugins/).
- <!-- coding-agents-section-end -->
- <!-- supported-linters-section-start -->
- <!-- markdown-headers
- ---
- title: List of the 100+ supported linters embedded in MegaLinter
- description: Full list of all linters for all languages and formats that are available in MegaLinter
- ---
- -->
- ## Supported Linters
- All linters are integrated into the [MegaLinter Docker image](https://hub.docker.com/r/oxsecurity/megalinter), which is frequently updated with their latest versions.
- <!-- languages-section-start-->
- <!-- linters-table-start -->
- ### Languages
- | <!-- --> | Language | Linter | Additional |
- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|---------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/bash.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**BASH**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash.md) | [**bash-exec**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md)<br/>[_BASH_EXEC_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md) | |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/bash.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**BASH**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash.md) | [**shellcheck**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md)<br/>[_BASH_SHELLCHECK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md) | [](https://github.com/koalaman/shellcheck)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/bash.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**BASH**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash.md) | [**shfmt**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md)<br/>[_BASH_SHFMT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md) | [](https://github.com/mvdan/sh)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/c.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c.md) | [**cppcheck**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cppcheck.md)<br/>[_C_CPPCHECK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cppcheck.md) |  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/c.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c.md) | [**cpplint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md)<br/>[_C_CPPLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md) | [](https://github.com/cpplint/cpplint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/c.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c.md) | [**clang-format**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_clang_format.md)<br/>[_C_CLANG_FORMAT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_clang_format.md) | [](https://github.com/llvm/llvm-project)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/clojure.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**CLOJURE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure.md) | [**clj-kondo**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md)<br/>[_CLOJURE_CLJ_KONDO_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md) | [](https://github.com/clj-kondo/clj-kondo)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/clojure.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**CLOJURE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure.md) | [**cljstyle**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_cljstyle.md)<br/>[_CLOJURE_CLJSTYLE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_cljstyle.md) | [](https://github.com/greglook/cljstyle)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/coffee.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**COFFEE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee.md) | <s>[**coffeelint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md)<br/>[_COFFEE_COFFEELINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md)</s> | <span title="Disabled: CoffeeScript tooling is discontinued, and coffeelint can not honor EXCLUDED_DIRECTORIES (it has no exclusion option and only reads .coffeelintignore from its working directory). The linter will be removed in a future version">๐ซ</span> [](https://github.com/clutchski/coffeelint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/cpp.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C++** (CPP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp.md) | [**cppcheck**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cppcheck.md)<br/>[_CPP_CPPCHECK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cppcheck.md) |  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/cpp.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C++** (CPP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp.md) | [**cpplint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md)<br/>[_CPP_CPPLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md) | [](https://github.com/cpplint/cpplint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/cpp.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C++** (CPP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp.md) | [**clang-format**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_clang_format.md)<br/>[_CPP_CLANG_FORMAT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_clang_format.md) | [](https://github.com/llvm/llvm-project)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/csharp.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C#** (CSHARP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp.md) | [**dotnet-format**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md)<br/>[_CSHARP_DOTNET_FORMAT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md) | [](https://github.com/dotnet/sdk)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/csharp.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C#** (CSHARP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp.md) | [**csharpier**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_csharpier.md)<br/>[_CSHARP_CSHARPIER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_csharpier.md) | [](https://github.com/belav/csharpier)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/csharp.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**C#** (CSHARP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp.md) | [**roslynator**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_roslynator.md)<br/>[_CSHARP_ROSLYNATOR_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_roslynator.md) | [](https://github.com/dotnet/Roslynator)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/dart.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**DART**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart.md) | [**dartanalyzer**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md)<br/>[_DART_DARTANALYZER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md) | [](https://github.com/dart-lang/sdk) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/go.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**GO**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go.md) | [**golangci-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md)<br/>[_GO_GOLANGCI_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md) | [](https://github.com/golangci/golangci-lint)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/go.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**GO**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go.md) | [**revive**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md)<br/>[_GO_REVIVE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md) | [](https://github.com/mgechev/revive)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/groovy.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**GROOVY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy.md) | [**npm-groovy-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md)<br/>[_GROOVY_NPM_GROOVY_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md) | [](https://github.com/nvuillam/npm-groovy-lint)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/java.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JAVA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java.md) | [**checkstyle**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md)<br/>[_JAVA_CHECKSTYLE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md) | [](https://github.com/checkstyle/checkstyle)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/java.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JAVA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java.md) | [**pmd**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_pmd.md)<br/>[_JAVA_PMD_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_pmd.md) | [](https://github.com/pmd/pmd)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/javascript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md) | [**eslint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md)<br/>[_JAVASCRIPT_ES_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md) | [](https://github.com/eslint/eslint)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/javascript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md) | [**standard**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md)<br/>[_JAVASCRIPT_STANDARD_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md) | [](https://github.com/standard/standard)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/javascript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md) | [**prettier**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md)<br/>[_JAVASCRIPT_PRETTIER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md) | [](https://github.com/prettier/prettier)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/javascript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_biome.md)<br/>[_JAVASCRIPT_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_biome.md) | [](https://github.com/biomejs/biome)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/jsx.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx.md) | [**eslint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md)<br/>[_JSX_ESLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md) | [](https://github.com/Rel1cx/eslint-react)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/jsx.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_biome.md)<br/>[_JSX_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_biome.md) | [](https://github.com/biomejs/biome)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/kotlin.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**KOTLIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin.md) | [**ktlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md)<br/>[_KOTLIN_KTLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md) | [](https://github.com/pinterest/ktlint)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/kotlin.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**KOTLIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin.md) | [**detekt**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_detekt.md)<br/>[_KOTLIN_DETEKT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_detekt.md) | [](https://github.com/detekt/detekt)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/lua.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**LUA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua.md) | [**luacheck**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md)<br/>[_LUA_LUACHECK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md) | [](https://github.com/lunarmodules/luacheck) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/lua.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**LUA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua.md) | [**stylua**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_stylua.md)<br/>[_LUA_STYLUA_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_stylua.md) | [](https://github.com/JohnnyMorganz/StyLua) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/perl.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PERL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl.md) | [**perlcritic**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md)<br/>[_PERL_PERLCRITIC_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md) | [](https://github.com/Perl-Critic/Perl-Critic) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/php.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md) | [**phpcs**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md)<br/>[_PHP_PHPCS_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md) | [](https://github.com/PHPCSStandards/PHP_CodeSniffer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/php.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md) | [**phpstan**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md)<br/>[_PHP_PHPSTAN_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md) | [](https://github.com/phpstan/phpstan)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/php.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md) | [**psalm**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md)<br/>[_PHP_PSALM_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md) | [](https://github.com/vimeo/psalm)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/php.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md) | [**phplint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md)<br/>[_PHP_PHPLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md) | [](https://github.com/overtrue/phplint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/php.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md) | [**php-cs-fixer**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_php_cs_fixer.md)<br/>[_PHP_PHPCSFIXER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_php_cs_fixer.md) | [](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/powershell.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**POWERSHELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell.md) | [**powershell**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md)<br/>[_POWERSHELL_POWERSHELL_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md) | [](https://github.com/PowerShell/PSScriptAnalyzer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/powershell.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**POWERSHELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell.md) | [**powershell_formatter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell_formatter.md)<br/>[_POWERSHELL_POWERSHELL_FORMATTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell_formatter.md) | [](https://github.com/PowerShell/PSScriptAnalyzer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**pylint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md)<br/>[_PYTHON_PYLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md) | [](https://github.com/pylint-dev/pylint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**black**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md)<br/>[_PYTHON_BLACK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md) | [](https://github.com/psf/black)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**flake8**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md)<br/>[_PYTHON_FLAKE8_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md) | [](https://github.com/PyCQA/flake8) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**isort**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md)<br/>[_PYTHON_ISORT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md) | [](https://github.com/PyCQA/isort)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**bandit**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md)<br/>[_PYTHON_BANDIT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md) | [](https://github.com/PyCQA/bandit)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**mypy**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md)<br/>[_PYTHON_MYPY_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md) | [](https://github.com/python/mypy) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**nbqa**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_nbqa.md)<br/>[_PYTHON_NBQA_MYPY_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_nbqa.md) | [](https://github.com/nbQA-dev/nbQA) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**pyright**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pyright.md)<br/>[_PYTHON_PYRIGHT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pyright.md) | [](https://github.com/microsoft/pyright) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**ruff**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_ruff.md)<br/>[_PYTHON_RUFF_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_ruff.md) | [](https://github.com/astral-sh/ruff)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**ruff-format**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_ruff_format.md)<br/>[_PYTHON_RUFF_FORMAT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_ruff_format.md) | [](https://github.com/astral-sh/ruff)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/python.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md) | [**ty**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_ty.md)<br/>[_PYTHON_TY_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_ty.md) | [](https://github.com/astral-sh/ty)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/r.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**R**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r.md) | [**lintr**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md)<br/>[_R_LINTR_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md) | [](https://github.com/r-lib/lintr)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/raku.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**RAKU**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku.md) | [**raku**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md)<br/>[_RAKU_RAKU_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md) | [](https://github.com/rakudo/rakudo) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/ruby.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**RUBY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby.md) | [**rubocop**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md)<br/>[_RUBY_RUBOCOP_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md) | [](https://github.com/rubocop-hq/rubocop)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/rust.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**RUST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust.md) | [**clippy**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md)<br/>[_RUST_CLIPPY_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md) | [](https://github.com/rust-lang/rust-clippy) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/salesforce.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md) | [**code-analyzer-apex**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_apex.md)<br/>[_SALESFORCE_CODE_ANALYZER_APEX_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_apex.md) | [](https://github.com/forcedotcom/code-analyzer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/salesforce.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md) | [**code-analyzer-apexguru**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_apexguru.md)<br/>[_SALESFORCE_CODE_ANALYZER_APEXGURU_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_apexguru.md) | [](https://github.com/forcedotcom/code-analyzer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/salesforce.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md) | [**code-analyzer-aura**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_aura.md)<br/>[_SALESFORCE_CODE_ANALYZER_AURA_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_aura.md) | [](https://github.com/forcedotcom/code-analyzer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/salesforce.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md) | [**code-analyzer-lwc**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_lwc.md)<br/>[_SALESFORCE_CODE_ANALYZER_LWC_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_lwc.md) | [](https://github.com/forcedotcom/code-analyzer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/salesforce.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md) | [**code-analyzer-flow**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_flow.md)<br/>[_SALESFORCE_CODE_ANALYZER_FLOW_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_code_analyzer_flow.md) | [](https://github.com/forcedotcom/code-analyzer)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/scala.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SCALA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala.md) | [**scalafix**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md)<br/>[_SCALA_SCALAFIX_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md) | [](https://github.com/scalacenter/scalafix) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/sql.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql.md) | [**sqlfluff**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md)<br/>[_SQL_SQLFLUFF_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md) | [](https://github.com/sqlfluff/sqlfluff)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/swift.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SWIFT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift.md) | [**swiftlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md)<br/>[_SWIFT_SWIFTLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md) | [](https://github.com/realm/SwiftLint)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/tsx.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx.md) | [**eslint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md)<br/>[_TSX_ESLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md) | [](https://github.com/Rel1cx/eslint-react)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/tsx.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_biome.md)<br/>[_TSX_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_biome.md) | [](https://github.com/biomejs/biome)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/typescript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md) | [**eslint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md)<br/>[_TYPESCRIPT_ES_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md) | [](https://github.com/typescript-eslint/typescript-eslint)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/typescript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md) | [**ts-standard**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_ts_standard.md)<br/>[_TYPESCRIPT_STANDARD_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_ts_standard.md) | [](https://github.com/standard/ts-standard)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/typescript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md) | [**prettier**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md)<br/>[_TYPESCRIPT_PRETTIER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md) | [](https://github.com/prettier/prettier)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/typescript.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_biome.md)<br/>[_TYPESCRIPT_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_biome.md) | [](https://github.com/biomejs/biome)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/vbdotnet.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**Visual Basic .NET** (VBDOTNET)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet.md) | [**dotnet-format**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md)<br/>[_VBDOTNET_DOTNET_FORMAT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md) | [](https://github.com/dotnet/sdk)  |
- ### Formats
- | <!-- --> | Format | Linter | Additional |
- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/css.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md) | [**stylelint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md)<br/>[_CSS_STYLELINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md) | [](https://github.com/stylelint/stylelint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/css.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_biome.md)<br/>[_CSS_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_biome.md) | [](https://github.com/biomejs/biome)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/env.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**ENV**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env.md) | [**dotenv-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md)<br/>[_ENV_DOTENV_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md) | [](https://github.com/dotenv-linter/dotenv-linter)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/graphql.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | <s>[**graphql-schema-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md)<br/>[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md)</s> | <span title="Disabled: graphql-schema-linter is unmaintained (no release or commit since May 2022) and its peer dependency range pins graphql to ^15 or ^16, which blocks the whole GraphQL npm install from moving to graphql v17. Use GRAPHQL_BIOME to lint GraphQL files. The linter will be removed in a future version">๐ซ</span> [](https://github.com/cjoudrey/graphql-schema-linter) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/graphql.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_biome.md)<br/>[_GRAPHQL_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_biome.md) | [](https://github.com/biomejs/biome)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/html.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md) | [**djlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_djlint.md)<br/>[_HTML_DJLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_djlint.md) | [](https://github.com/djlint/djLint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/html.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md) | [**htmlhint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md)<br/>[_HTML_HTMLHINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md) | [](https://github.com/htmlhint/HTMLHint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/json.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**jsonlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md)<br/>[_JSON_JSONLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md) | [](https://github.com/prantlf/jsonlint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/json.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**v8r**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md)<br/>[_JSON_V8R_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md) | [](https://github.com/chris48s/v8r) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/json.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**prettier**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md)<br/>[_JSON_PRETTIER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md) | [](https://github.com/prettier/prettier)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/json.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**npm-package-json-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_npm_package_json_lint.md)<br/>[_JSON_NPM_PACKAGE_JSON_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_npm_package_json_lint.md) | [](https://github.com/tclindner/npm-package-json-lint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/json.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_biome.md)<br/>[_JSON_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_biome.md) | [](https://github.com/biomejs/biome)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/latex.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md) | [**chktex**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md)<br/>[_LATEX_CHKTEX_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md) | |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/markdown.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**markdownlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md)<br/>[_MARKDOWN_MARKDOWNLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md) | [](https://github.com/DavidAnson/markdownlint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/markdown.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**markdown-table-formatter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md)<br/>[_MARKDOWN_MARKDOWN_TABLE_FORMATTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md) | [](https://github.com/nvuillam/markdown-table-formatter)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/markdown.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**rumdl**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_rumdl.md)<br/>[_MARKDOWN_RUMDL_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_rumdl.md) | [](https://github.com/rvben/rumdl)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/protobuf.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**PROTOBUF**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf.md) | [**protolint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md)<br/>[_PROTOBUF_PROTOLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md) | [](https://github.com/yoheimuta/protolint)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/rst.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**RST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst.md) | [**rst-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md)<br/>[_RST_RST_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md) | [](https://github.com/twolfson/restructuredtext-lint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/rst.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**RST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst.md) | [**rstcheck**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md)<br/>[_RST_RSTCHECK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md) | [](https://github.com/myint/rstcheck) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/rst.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**RST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst.md) | [**rstfmt**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstfmt.md)<br/>[_RST_RSTFMT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstfmt.md) |  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/xml.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**XML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml.md) | [**xmllint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md)<br/>[_XML_XMLLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md) |  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/yaml.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**YAML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml.md) | [**prettier**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md)<br/>[_YAML_PRETTIER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md) | [](https://github.com/prettier/prettier)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/yaml.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**YAML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml.md) | [**yamllint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md)<br/>[_YAML_YAMLLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md) | [](https://github.com/adrienverge/yamllint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/yaml.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**YAML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml.md) | [**v8r**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md)<br/>[_YAML_V8R_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md) | [](https://github.com/chris48s/v8r) |
- ### Tooling formats
- | <!-- --> | Tooling format | Linter | Additional |
- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**ACTION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action.md) | [**actionlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md)<br/>[_ACTION_ACTIONLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md) | [](https://github.com/rhysd/actionlint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**ACTION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action.md) | [**zizmor**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_zizmor.md)<br/>[_ACTION_ZIZMOR_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_zizmor.md) | [](https://github.com/zizmorcore/zizmor)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/ansible.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**ANSIBLE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible.md) | [**ansible-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md)<br/>[_ANSIBLE_ANSIBLE_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md) | [](https://github.com/ansible/ansible-lint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**API**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/api.md) | [**spectral**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/api_spectral.md)<br/>[_API_SPECTRAL_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/api_spectral.md) | [](https://github.com/stoplightio/spectral)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/arm.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**ARM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm.md) | [**arm-ttk**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md)<br/>[_ARM_ARM_TTK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md) | [](https://github.com/Azure/arm-ttk) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**BICEP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bicep.md) | [**bicep_linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bicep_bicep_linter.md)<br/>[_BICEP_BICEP_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bicep_bicep_linter.md) | [](https://github.com/Azure/bicep)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/cloudformation.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**CLOUDFORMATION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation.md) | [**cfn-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md)<br/>[_CLOUDFORMATION_CFN_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md) | [](https://github.com/aws-cloudformation/cfn-lint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/dockerfile.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**DOCKERFILE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile.md) | [**hadolint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md)<br/>[_DOCKERFILE_HADOLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md) | [](https://github.com/hadolint/hadolint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/editorconfig.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**EDITORCONFIG**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig.md) | [**editorconfig-checker**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md)<br/>[_EDITORCONFIG_EDITORCONFIG_CHECKER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md) | [](https://github.com/editorconfig-checker/editorconfig-checker) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/gherkin.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**GHERKIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin.md) | [**gherkin-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md)<br/>[_GHERKIN_GHERKIN_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md) | [](https://github.com/gherkin-lint/gherkin-lint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/kubernetes.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**KUBERNETES**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes.md) | [**kubeconform**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md)<br/>[_KUBERNETES_KUBECONFORM_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md) | [](https://github.com/yannh/kubeconform) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/kubernetes.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**KUBERNETES**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes.md) | [**helm**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_helm.md)<br/>[_KUBERNETES_HELM_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_helm.md) | [](https://github.com/helm/helm) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/kubernetes.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**KUBERNETES**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes.md) | [**kubescape**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubescape.md)<br/>[_KUBERNETES_KUBESCAPE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubescape.md) | [](https://github.com/kubescape/kubescape)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**ROBOTFRAMEWORK**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/robotframework.md) | [**robocop**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/robotframework_robocop.md)<br/>[_ROBOTFRAMEWORK_ROBOCOP_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/robotframework_robocop.md) | [](https://github.com/MarketSquare/robotframework-robocop)   |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/snakemake.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SNAKEMAKE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake.md) | [**snakemake**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md)<br/>[_SNAKEMAKE_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md) | [](https://github.com/snakemake/snakemake) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/snakemake.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SNAKEMAKE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake.md) | [**snakefmt**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md)<br/>[_SNAKEMAKE_SNAKEFMT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md) | [](https://github.com/snakemake/snakefmt)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/tekton.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TEKTON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton.md) | [**tekton-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md)<br/>[_TEKTON_TEKTON_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md) | [](https://github.com/IBM/tekton-lint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/terraform.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md) | [**tflint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md)<br/>[_TERRAFORM_TFLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md) | [](https://github.com/terraform-linters/tflint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/terraform.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md) | [**terragrunt**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md)<br/>[_TERRAFORM_TERRAGRUNT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md) | [](https://github.com/gruntwork-io/terragrunt)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/terraform.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md) | [**terraform-fmt**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md)<br/>[_TERRAFORM_TERRAFORM_FMT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md) | [](https://github.com/hashicorp/terraform)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/terraform.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md) | [**tofu-fmt**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tofu_fmt.md)<br/>[_TERRAFORM_TOFU_FMT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tofu_fmt.md) | [](https://github.com/opentofu/opentofu)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/terraform.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md) | [**tofu-validate**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tofu_validate.md)<br/>[_TERRAFORM_TOFU_VALIDATE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tofu_validate.md) | [](https://github.com/opentofu/opentofu) |
- ### Other
- | <!-- --> | Code quality checker | Linter | Additional |
- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/copypaste.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**COPYPASTE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste.md) | [**jscpd**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md)<br/>[_COPYPASTE_JSCPD_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md) | [](https://github.com/kucherenko/jscpd)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**checkov**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_checkov.md)<br/>[_REPOSITORY_CHECKOV_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_checkov.md) | [](https://github.com/bridgecrewio/checkov)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**devskim**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md)<br/>[_REPOSITORY_DEVSKIM_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md) | [](https://github.com/microsoft/DevSkim)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**dustilock**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md)<br/>[_REPOSITORY_DUSTILOCK_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md) | [](https://github.com/Checkmarx/dustilock)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**git_diff**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md)<br/>[_REPOSITORY_GIT_DIFF_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md) | [](https://github.com/git/git) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**betterleaks**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_betterleaks.md)<br/>[_REPOSITORY_BETTERLEAKS_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_betterleaks.md) | [](https://github.com/betterleaks/betterleaks)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**grype**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_grype.md)<br/>[_REPOSITORY_GRYPE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_grype.md) | [](https://github.com/anchore/grype)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**ls-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_ls_lint.md)<br/>[_REPOSITORY_LS_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_ls_lint.md) | [](https://github.com/loeffel-io/ls-lint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**osv-scanner**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_osv_scanner.md)<br/>[_REPOSITORY_OSV_SCANNER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_osv_scanner.md) | [](https://github.com/google/osv-scanner)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**secretlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md)<br/>[_REPOSITORY_SECRETLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md) | [](https://github.com/secretlint/secretlint)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**semgrep**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md)<br/>[_REPOSITORY_SEMGREP_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md) | [](https://github.com/returntocorp/semgrep)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**syft**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md)<br/>[_REPOSITORY_SYFT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md) | [](https://github.com/anchore/syft)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**trivy**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md)<br/>[_REPOSITORY_TRIVY_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md) | [](https://github.com/aquasecurity/trivy)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**trivy-sbom**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy_sbom.md)<br/>[_REPOSITORY_TRIVY_SBOM_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy_sbom.md) | [](https://github.com/aquasecurity/trivy)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**trufflehog**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trufflehog.md)<br/>[_REPOSITORY_TRUFFLEHOG_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trufflehog.md) | [](https://github.com/trufflesecurity/trufflehog) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/default.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md) | [**kingfisher**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_kingfisher.md)<br/>[_REPOSITORY_KINGFISHER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_kingfisher.md) | [](https://github.com/mongodb/kingfisher)  |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/spell.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md) | [**cspell**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md)<br/>[_SPELL_CSPELL_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md) | [](https://github.com/streetsidesoftware/cspell) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/spell.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md) | [**proselint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_proselint.md)<br/>[_SPELL_PROSELINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_proselint.md) | [](https://github.com/amperser/proselint) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/spell.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md) | [**vale**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_vale.md)<br/>[_SPELL_VALE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_vale.md) | [](https://github.com/errata-ai/vale) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/spell.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md) | [**lychee**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_lychee.md)<br/>[_SPELL_LYCHEE_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_lychee.md) | [](https://github.com/lycheeverse/lychee) |
- | <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/spell.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon --> | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md) | [**codespell**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_codespell.md)<br/>[_SPELL_CODESPELL_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_codespell.md) | [](https://github.com/codespell-project/codespell)  |
- <!-- linters-table-end -->
- <!-- supported-linters-section-end -->
- <!-- installation-section-start -->
- <!-- markdown-headers
- ---
- title: MegaLinter Installation Guide
- description: How to install MegaLinter on Github Actions, Gitlab CI, Azure Pipelines, Jenkins, Concourse, Drone CI or to run locally
- ---
- -->
- ## Installation
- <!-- install-agent-skills-section-start -->
- <!-- markdown-headers
- ---
- title: Install and use MegaLinter with coding agents
- description: Setup and drive MegaLinter from Claude Code, Cursor, GitHub Copilot CLI, Codex, OpenCode and other coding agents thanks to MegaLinter agent skills
- ---
- -->
- ### Coding agents (skills)
- MegaLinter ships [**agent skills**](https://github.com/oxsecurity/megalinter/tree/main/skills) making it easy to drive from coding agents like **Claude Code, Cursor CLI, GitHub Copilot CLI, Codex, Antigravity or OpenCode**:
- With **Claude Code** (the skills are copied directly into `.claude/skills/`):
- ```bash
- npx skills add oxsecurity/megalinter/skills -s '*' -a claude-code -y
- ```
- With **another coding agent**, replace `claude-code` with your agent's identifier (`cursor`, `github-copilot`, `codex`, `antigravity`, `opencode`... full list in the [skills CLI documentation](https://github.com/vercel-labs/skills#supported-agents)) โ or let the CLI **detect your installed agents** and install the skills for all of them at once:
- ```bash
- npx skills add oxsecurity/megalinter/skills -s '*' -y --copy
- ```
- Then just ask your agent to _"setup megalinter"_ or _"run megalinter and fix the errors"_. The skills handle:
- - **megalinter-setup**: install or upgrade MegaLinter on the repository (non-interactive `npx mega-linter-runner --install`)
- - **megalinter-check**: watch MegaLinter CI jobs (GitHub Actions, GitLab CI, Azure Pipelines, Bitbucket Pipelines) or run locally with Docker
- - **megalinter-fix**: apply fixes guided by per-linter fix guides, with user confirmation before disabling anything or pushing
- - **megalinter**: orchestrate the whole check โ fix โ re-check loop
- On coding agents supporting sub-agents (Claude Code, OpenCode, GitHub Copilot custom agents...), dedicated MegaLinter sub-agents (running on low-cost models) watch CI jobs and digest linter outputs to keep large logs out of your agent's context, and fix several linters in parallel.
- <!-- install-agent-skills-section-end -->
- <!-- agent-plugins-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter agent plugins
- description: Install the MegaLinter skills and sub-agents as a native plugin on Claude Code, Cursor, GitHub Copilot, Codex, Gemini CLI and Antigravity
- ---
- -->
- ## Coding Agents (Plugins)
- The MegaLinter [agent skills](https://megalinter.io/latest/install-agent-skills/) are also published as an **agent plugin**, so a single command installs all four skills at once, and keeps them updated.
- ### Claude Code
- ```bash
- /plugin marketplace add oxsecurity/megalinter
- /plugin install megalinter@megalinter
- ```
- The three MegaLinter sub-agents are installed with the plugin, so there is nothing else to set up.
- ### Cursor
- Add `https://github.com/oxsecurity/megalinter` as a plugin source from **Customize โ Plugins**, then install **MegaLinter**. The sub-agents ship with the plugin.
- ### GitHub Copilot
- ```bash
- copilot plugin marketplace add oxsecurity/megalinter
- copilot plugin install megalinter@megalinter
- ```
- ### Codex
- ```bash
- codex plugin marketplace add oxsecurity/megalinter
- ```
- Then install **MegaLinter** from the `/plugins` browser.
- ### Gemini CLI and Antigravity
- ```bash
- gemini extensions install https://github.com/oxsecurity/megalinter
- ```
- ### Other coding agents
- Every other agent (Windsurf, Cline, Roo Code, Amp, OpenCode, Goose, OpenHands...) is covered by the [skills installation](https://megalinter.io/latest/install-agent-skills/) with `npx skills add oxsecurity/megalinter/skills`.
- Once installed, just ask your agent to _"setup megalinter"_ or _"run megalinter and fix the errors"_.
- <!-- agent-plugins-section-end -->
- <!-- install-assisted-section-start -->
- <!-- markdown-headers
- ---
- title: Install mega-linter with automated setup
- description: Setup MegaLinter in 5 minutes thanks to its assisted installation tool
- ---
- -->
- ### Assisted installation
- Two assisted ways to setup MegaLinter on your repository:
- - **With a coding agent**: install the [MegaLinter agent skills](https://megalinter.io/latest/install-agent-skills/) with `npx skills add oxsecurity/megalinter/skills`, then ask your agent to _"setup megalinter"_.
- - **With the interactive wizard**: run `npx mega-linter-runner --install` at the root of your repository and answer questions, it will generate ready to use configuration files for MegaLinter :)
- 
- <!-- install-assisted-section-end -->
- <!-- install-version-section-start -->
- <!-- markdown-headers
- ---
- title: Selecting a MegaLinter version to use
- description: You can use latest release or beta version of MegaLinter, know the differences !
- ---
- -->
- ### Which version to use ?
- <!-- # MAJOR-RELEASE-IMPACTED -->
- > **Docker registry change (since v9.5.0)**: MegaLinter Docker images are **published only to GitHub Container Registry (`ghcr.io`)**. The Docker Hub registry (`docker.io/oxsecurity/megalinter`, formerly `oxsecurity/megalinter:*`) is **frozen at v9.4.0** until we implement OIDC-based publishing to Docker Hub.
- > Docker Hub does not have v10 images: if you pull `oxsecurity/megalinter` from Docker Hub you will stay on v9.4.0. To get v10, switch your `image:` / `docker pull` references to `ghcr.io/oxsecurity/megalinter:v10` (same applies to `:beta` and all [flavor](#flavors) tags like `ghcr.io/oxsecurity/megalinter-python:v10`).
- > GitHub Action users (`uses: oxsecurity/megalinter@v10`) are not affected, as the action already pulls from `ghcr.io`.
- The following instructions examples are using latest MegaLinter stable version (**v10** , always corresponding to the [latest release](https://github.com/oxsecurity/megalinter/releases))
- - Docker image: `ghcr.io/oxsecurity/megalinter:v10`
- - GitHub Action: `oxsecurity/megalinter@v10`
- You can also use **beta** version (corresponding to the content of main branch)
- - Docker image: `ghcr.io/oxsecurity/megalinter:beta`
- - GitHub Action: `oxsecurity/megalinter@beta`
- <!-- install-version-section-end -->
- <!-- install-github-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter on GitHub Actions
- description: Manual instructions to setup MegaLinter in a GitHub Action Workflow
- ---
- -->
- ### GitHub Action
- 1. Create a new file in your repository called `.github/workflows/mega-linter.yml`
- 2. Copy the [example workflow from below](https://raw.githubusercontent.com/oxsecurity/megalinter/main/TEMPLATES/mega-linter.yml) into that new file, no extra configuration required
- 3. Commit that file to a new branch
- 4. Open up a pull request and observe the action working
- 5. Enjoy your more _stable_, and _cleaner_ code base
- **NOTES:**
- - If you pass the _Environment_ variable `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}` in your workflow, then the **MegaLinter** will mark the status of each individual linter run in the Checks section of a pull request. Without this you will only see the overall status of the full run. There is no need to set the **GitHub** Secret as it's automatically set by GitHub, it only needs to be passed to the action.
- - You can also **use it outside of GitHub Actions** (CircleCI, Azure Pipelines, Jenkins, GitLab, or even locally with a docker run) , and have status on Github Pull Request if `GITHUB_TARGET_URL` environment variable exists.
- In your repository you should have a `.github/workflows` folder with **GitHub** Action similar to below:
- - `.github/workflows/mega-linter.yml`
- <details>
- <summary>This file should have this code</summary>
- ```yml
- ---
- # MegaLinter GitHub Action configuration file
- # More info at https://megalinter.io
- name: MegaLinter
- on:
- # Trigger mega-linter at every push. Action will also be visible from Pull Requests to main
- push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
- pull_request:
- branches: [master, main]
- env: # Comment env block if you don't want to apply fixes
- # Apply linter fixes configuration
- APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
- APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
- APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
- concurrency:
- group: ${{ github.ref }}-${{ github.workflow }}
- cancel-in-progress: true
- permissions: {}
- jobs:
- megalinter:
- name: MegaLinter
- runs-on: ubuntu-latest
- permissions:
- # Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
- # Remove the ones you do not need
- contents: write
- issues: write
- pull-requests: write
- steps:
- # Git Checkout
- - name: Checkout Code
- uses: actions/checkout@v6
- with:
- # SECURITY NOTE: Using a Personal Access Token (PAT) is NOT
- # recommended. Open-source projects have been heavily targeted by
- # supply-chain attacks in recent months, and a leaked PAT can give
- # attackers broad write access to your repository: better safe
- # than sorry! If you only need workflows to re-trigger after
- # MegaLinter applies fixes, prefer one of these safer alternatives:
- # - Manually re-run the workflow from the GitHub Actions tab, or
- # - Push another commit on the branch to trigger workflows again.
- # Only define `secrets.PAT` if you fully understand the trade-off.
- token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
- persist-credentials: false # Comment this line and uncomment the next one if you use APPLY_FIXES
- # persist-credentials: true # zizmor: ignore[artipacked]
- fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
- # MegaLinter
- - name: MegaLinter
- id: ml
- # You can override MegaLinter flavor used to have faster performances
- # More info at https://megalinter.io/flavors/
- # MAJOR-RELEASE-IMPACTED
- uses: oxsecurity/megalinter@v10
- env:
- # All available variables are described in documentation
- # https://megalinter.io/configuration/
- VALIDATE_ALL_CODEBASE: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
- # DISABLE: COPYPASTE,SPELL # Uncomment to disable copy-paste and spell checks
- # Upload MegaLinter artifacts
- - name: Archive production artifacts
- if: success() || failure()
- uses: actions/upload-artifact@v7
- with:
- name: MegaLinter reports
- include-hidden-files: "true"
- path: |
- megalinter-reports
- mega-linter.log
- # Create pull request if applicable (for now works only on PR from same repository, not from forks)
- - name: Create Pull Request with applied fixes
- id: cpr
- if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
- uses: peter-evans/create-pull-request@v8
- with:
- # SECURITY NOTE: see the warning on the checkout step above โ
- # using `secrets.PAT` is NOT recommended for security reasons.
- # Prefer manually re-running the workflow or pushing another
- # commit on the branch to trigger workflows again.
- token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
- commit-message: "[MegaLinter] Apply linters automatic fixes"
- title: "[MegaLinter] Apply linters automatic fixes"
- labels: bot
- - name: Create PR output
- if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
- env:
- PR_NUMBER: ${{ steps.cpr.outputs.pull-request-number }}
- PR_URL: ${{ steps.cpr.outputs.pull-request-url }}
- run: |
- echo "Pull Request Number - ${PR_NUMBER}"
- echo "Pull Request URL - ${PR_URL}"
- # Push new commit if applicable (for now works only on PR from same repository, not from forks)
- - name: Prepare commit
- if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
- run: sudo chown -Rc $UID .git/
- - name: Commit and push applied linter fixes
- if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
- uses: stefanzweifel/git-auto-commit-action@v7
- with:
- branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
- commit_message: "[MegaLinter] Apply linters fixes"
- commit_user_name: megalinter-bot
- commit_user_email: 129584137+megalinter-bot@users.noreply.github.com
- ```
- </details>
- <!-- install-github-section-end -->
- <!-- install-gitlab-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter on Gitlab CI
- description: Manual instructions to setup MegaLinter as a Gitlab Pipeline job
- ---
- -->
- ### GitLab CI
- Create or update `.gitlab-ci.yml` file at the root of your repository
- ```yaml
- # MegaLinter GitLab CI job configuration file
- # More info at https://megalinter.io/
- mega-linter:
- stage: test
- # You can override MegaLinter flavor used to have faster performances
- # More info at https://megalinter.io/flavors/
- image: ghcr.io/oxsecurity/megalinter:v10
- script: [ "true" ] # if script: ["true"] doesn't work, you may try -> script: [ "/bin/bash /entrypoint.sh" ]
- variables:
- # All available variables are described in documentation
- # https://megalinter.io/configuration/
- DEFAULT_WORKSPACE: $CI_PROJECT_DIR
- # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
- artifacts:
- when: always
- paths:
- - megalinter-reports
- expire_in: 1 week
- ```
- Create a Gitlab access token and define it in a variable **GITLAB_ACCESS_TOKEN_MEGALINTER** in the project CI/CD masked variables. Make sure your token (e.g. if a project token) as the appropriate [role](https://docs.gitlab.com/ee/user/permissions.html) for commenting a merge request (at least developer).
- 
- 
- <!-- install-gitlab-section-end -->
- <!-- install-azure-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter on Azure Pipelines
- description: Manual instructions to setup MegaLinter as an Azure Pipelines job
- ---
- -->
- ### Azure Pipelines
- Use the following Azure Pipelines [YAML template](https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema)
- You can configure a [build validation](https://learn.microsoft.com/en-us/azure/devops/repos/git/branch-policies?view=azure-devops&tabs=browser#build-validation) branch policy against a single repository or across all repositories. If you configure across all repositories then your pipeline is stored in a central repository.
- #### Single Repository
- Add the following to an `azure-pipelines.yaml` file within your code repository:
- ```yaml
- # Run MegaLinter to detect linting and security issues
- - job: MegaLinter
- pool:
- vmImage: ubuntu-latest
- steps:
- # Checkout repo
- - checkout: self
- # Pull MegaLinter docker image
- - script: docker pull ghcr.io/oxsecurity/megalinter:v10
- displayName: Pull MegaLinter
- # Run MegaLinter
- - script: |
- docker run -v $(System.DefaultWorkingDirectory):/tmp/lint \
- --env-file <(env | grep -e SYSTEM_ -e BUILD_ -e TF_ -e AGENT_) \
- -e SYSTEM_ACCESSTOKEN=$(System.AccessToken) \
- -e GIT_AUTHORIZATION_BEARER=$(System.AccessToken) \
- ghcr.io/oxsecurity/megalinter:v10
- displayName: Run MegaLinter
- # Upload MegaLinter reports
- - task: PublishPipelineArtifact@1
- condition: succeededOrFailed()
- displayName: Upload MegaLinter reports
- inputs:
- targetPath: "$(System.DefaultWorkingDirectory)/megalinter-reports/"
- artifactName: MegaLinterReport
- ```
- #### Central Repository
- Add the following to an `azure-pipelines.yaml` file within a separate repository, for example a 'MegaLinter' repository:
- ```yaml
- # Run MegaLinter to detect linting and security issues
- trigger: none
- pool:
- vmImage: ubuntu-latest
- variables:
- repoName: $[ replace(split(variables['System.PullRequest.SourceRepositoryURI'], '/')[6], '%20', ' ') ]
- steps:
- # Checkout triggering repo
- - checkout: git://$(System.TeamProject)/$(repoName)@$(System.PullRequest.SourceBranch)
- displayName: Checkout Triggering Repository
- # Pull MegaLinter docker image
- - script: docker pull ghcr.io/oxsecurity/megalinter:v10
- displayName: Pull MegaLinter
- # Run MegaLinter
- - script: |
- docker run -v $(System.DefaultWorkingDirectory):/tmp/lint \
- --env-file <(env | grep -e SYSTEM_ -e BUILD_ -e TF_ -e AGENT_) \
- -e SYSTEM_ACCESSTOKEN=$(System.AccessToken) \
- -e GIT_AUTHORIZATION_BEARER=$(System.AccessToken) \
- ghcr.io/oxsecurity/megalinter:v10
- displayName: Run MegaLinter
- # Upload MegaLinter reports
- - task: PublishPipelineArtifact@1
- condition: succeededOrFailed()
- displayName: MegaLinter Report
- inputs:
- targetPath: $(System.DefaultWorkingDirectory)/megalinter-reports/
- artifactName: MegaLinterReport
- ```
- #### Pull Request Comments
- To enable Pull Request comments, follow the [configuration instructions](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/AzureCommentReporter.md).
- Note: If your pipelines run on Azure DevOps but your source code is hosted on GitHub, and you want status reports to appear on GitHub, you must provide additional repository information to the pipeline. See this [example](https://github.com/firedigger/megalinter-azure-pipelines-with-github-repository) for guidance.
- #### Detailed Tutorial
- You can also follow this [detailed tutorial](https://github.com/DonKoning/megaLinter) by [DonKoning](https://github.com/DonKoning).
- #### Alternative: Azure DevOps Extension (Community)
- > **Note:** This is a community-maintained extension and is **not** affiliated with or maintained by the MegaLinter team.
- As an alternative to the manual Docker configuration above, the community-maintained [megalinter-ado](https://marketplace.visualstudio.com/items?itemName=DownAtTheBottomOfTheMoleHole.megalinter-ado) Azure DevOps extension provides a native Azure Pipelines task for running MegaLinter.
- Install from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=DownAtTheBottomOfTheMoleHole.megalinter-ado), then add the task to your pipeline:
- ```yaml
- - task: MegaLinter@1
- displayName: Run MegaLinter
- inputs:
- flavor: all
- fix: true
- createFixPR: true
- env:
- SYSTEM_ACCESSTOKEN: $(System.AccessToken)
- ```
- See the [extension repository](https://github.com/DownAtTheBottomOfTheMoleHole/megalinter-ado) for full configuration options.
- <!-- install-azure-section-end -->
- <!-- install-bitbucket-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter on Bitbucket Pipelines
- description: Manual instructions to setup MegaLinter as a Bitbucket Pipelines job
- ---
- -->
- ### Bitbucket Pipelines
- 1. Create a `bitbucket-pipelines.yml` file at the root of your repository.
- 2. Copy and paste the following template or add the step to your existing pipeline.
- ```yaml
- image: atlassian/default-image:3
- pipelines:
- default:
- - parallel:
- - step:
- name: Run MegaLinter
- image: ghcr.io/oxsecurity/megalinter:v10
- script:
- - export DEFAULT_WORKSPACE=$BITBUCKET_CLONE_DIR && bash /entrypoint.sh
- artifacts:
- - megalinter-reports/**
- ```
- <!-- install-bitbucket-section-end -->
- <!-- install-jenkins-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter on Jenkins
- description: Manual instructions to setup MegaLinter as a Jenkins job
- ---
- -->
- ### Jenkins
- Add the following stage to your Jenkinsfile.
- You may activate the [File.io reporter](https://megalinter.io/reporters/FileIoReporter/) or [Email reporter](https://megalinter.io/reporters/EmailReporter/) to access detailed logs and fixed sources.
- ```groovy
- // Lint with MegaLinter: https://megalinter.io/
- stage('MegaLinter') {
- agent {
- docker {
- image 'ghcr.io/oxsecurity/megalinter:v10'
- args "-u root -e VALIDATE_ALL_CODEBASE=true -v ${WORKSPACE}:/tmp/lint --entrypoint=''"
- reuseNode true
- }
- }
- steps {
- sh '/entrypoint.sh'
- }
- post {
- always {
- archiveArtifacts allowEmptyArchive: true, artifacts: 'mega-linter.log,megalinter-reports/**/*', defaultExcludes: false, followSymlinks: false
- }
- }
- }
- ```
- CloudBees has a helpful tutorial about how to use MegaLinter with Jenkins!
- <div style="text-align:center"><iframe width="560" height="315" src="https://www.youtube.com/embed/KhkNf2tQ3hM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
- ### PR Comment Reporting from Jenkins
- When MegaLinter runs from a **Jenkins Multibranch Pipeline**, it can automatically post results as comments on pull requests / merge requests hosted on GitHub, GitLab, Azure DevOps, or Bitbucket.
- MegaLinter auto-detects the git hosting platform by inspecting the `GIT_URL` environment variable (provided by Jenkins Git plugin). It then maps Jenkins environment variables (`CHANGE_ID`, `GIT_COMMIT`, `BUILD_URL`, etc.) to the native CI variables each comment reporter expects.
- #### Requirements
- - **Jenkins Multibranch Pipeline** with the appropriate Branch Source plugin (GitHub Branch Source, GitLab Branch Source, or Bitbucket Branch Source)
- - The pipeline must be triggered by a **pull request / merge request** (so `CHANGE_ID` is set by Jenkins)
- - An **authentication token** for the target platform, stored as a Jenkins credential
- #### Platform Configuration
- | Platform | Required Token Variable | Notes |
- |--------------|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- | GitHub | `GITHUB_TOKEN` (recommended) โ `PAT` only if strictly required | Prefer `GITHUB_TOKEN`. Personal Access Tokens (PAT) are **not recommended** due to recent supply-chain attacks on open-source projects; a leaked PAT can give attackers broad write access to your repository. Token needs `repo` scope (or `issues:write` + `pull-requests:write` for fine-grained tokens). |
- | GitLab | `GITLAB_ACCESS_TOKEN_MEGALINTER` | Personal access token with `api` scope |
- | Azure DevOps | `SYSTEM_ACCESSTOKEN` | Personal access token with **Code (Read & Write)** permission |
- | Bitbucket | `BITBUCKET_REPO_ACCESS_TOKEN` | Repository access token with **Pull-requests: Write** scope |
- #### Jenkinsfile Example with GitHub PR Comments
- ```groovy
- // Lint with MegaLinter: https://megalinter.io/
- stage('MegaLinter') {
- agent {
- docker {
- image 'ghcr.io/oxsecurity/megalinter:v10'
- args "-u root -e VALIDATE_ALL_CODEBASE=true -v ${WORKSPACE}:/tmp/lint --entrypoint=''"
- reuseNode true
- }
- }
- environment {
- GITHUB_TOKEN = credentials('github-token')
- }
- steps {
- sh '/entrypoint.sh'
- }
- post {
- always {
- archiveArtifacts allowEmptyArchive: true, artifacts: 'mega-linter.log,megalinter-reports/**/*', defaultExcludes: false, followSymlinks: false
- }
- }
- }
- ```
- #### Self-hosted / On-premise Platforms
- MegaLinter detects the platform by looking for keywords in the `GIT_URL` hostname (e.g., `gitlab.mycompany.com` is detected as GitLab, `github.internal.corp.com` as GitHub).
- If your self-hosted instance uses a hostname without the platform name (e.g., `git.mycompany.com`), set the `JENKINS_REPO_PLATFORM` environment variable to explicitly tell MegaLinter which platform to use:
- ```groovy
- environment {
- JENKINS_REPO_PLATFORM = 'gitlab' // or 'github', 'azure', 'bitbucket'
- GITLAB_ACCESS_TOKEN_MEGALINTER = credentials('gitlab-token')
- }
- ```
- #### Additional Variables
- For most setups, MegaLinter derives all needed variables automatically. In rare cases, you may need to set additional platform-specific variables:
- - **GitLab**: Set `CI_PROJECT_ID` if the project path cannot be parsed from `GIT_URL`
- - **Azure DevOps**: Set `SYSTEM_ACCESSTOKEN` as a Jenkins credential
- <!-- install-jenkins-section-end -->
- <!-- install-concourse-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter on Concourse
- description: Manual instructions to setup MegaLinter as a Concourse job
- ---
- -->
- ### Concourse
- #### Pipeline step
- Use the following job step in your pipeline template.
- Note: Make sure you have a `job.plan.get` step that retrieves the `repo` containing your repository, as shown in the example.
- <!-- # MAJOR-RELEASE-IMPACTED -->
- ```yaml
- ---
- - name: linting
- plan:
- - get: repo
- - task: linting
- config:
- platform: linux
- image_resource:
- type: docker-image
- source:
- repository: oxsecurity/megalinter
- tag: v10
- inputs:
- - name: repo
- run:
- path: bash
- args:
- - -cxe
- - |
- cd repo
- export DEFAULT_WORKSPACE=$(pwd)
- bash -ex /entrypoint.sh
- ## doing this because concourse doesn't work as other CI systems
- # params:
- # PARALLEL: true
- # DISABLE: SPELL
- # APPLY_FIXES: all
- # DISABLE_ERRORS: true
- # VALIDATE_ALL_CODEBASE: true
- ```
- OR
- #### Use it as a reusable task
- Create a reusable Concourse task that can be used with multiple pipelines.
- 1. Create task file `task-linting.yaml`
- <!-- # MAJOR-RELEASE-IMPACTED -->
- ```yaml
- ---
- platform: linux
- image_resource:
- type: docker-image
- source:
- repository: oxsecurity/megalinter
- tag: v10
- inputs:
- - name: repo
- ## uncomment this if you want reports as task output
- # output:
- # - name: reports
- # path: repo/megalinter-reports
- run:
- path: bash
- args:
- - -cxe
- - |
- cd repo
- export DEFAULT_WORKSPACE=$(pwd)
- bash -ex /entrypoint.sh
- ```
- 2. Use that `task-linting.yaml` task in your pipeline.
- Note:
- 1. Make sure `task-linting.yaml` is available in the `repo` input at the repository root.
- 2. Task `output` is **not** shown here.
- ```yaml
- resources:
- - name: linting
- plan:
- - get: repo
- - task: linting
- file: repo/task-linting.yaml
- # params:
- # PARALLEL: true
- # DISABLE: SPELL
- # APPLY_FIXES: all
- # DISABLE_ERRORS: true
- # VALIDATE_ALL_CODEBASE: true
- ```
- <!-- install-concourse-section-end -->
- <!-- install-drone-section-start -->
- <!-- markdown-headers
- ---
- title: Install MegaLinter on Drone CI
- description: Manual instructions to setup MegaLinter as a Drone CI job
- ---
- -->
- ### Drone CI
- Warning: Drone CI support is experimental and is undergoing significant modifications (see issue [#2047](https://github.com/oxsecurity/megalinter/issues/2047)).
- 1. Create a `.drone.yml` file on the root directory of your repository
- 2. Copy and paste the following template:
- ```yaml
- kind: pipeline
- type: docker
- name: MegaLinter
- workspace:
- path: /tmp/lint
- steps:
- - name: megalinter
- image: ghcr.io/oxsecurity/megalinter:v10
- environment:
- DEFAULT_WORKSPACE: /tmp/lint
- ```
- This uses the [Drone CI Docker runner](https://docs.drone.io/pipeline/docker/overview/), so you need to install and configure it beforehand on your Drone CI server.
- #### (Optional) Adjusting trigger rules
- The Drone CI workflow should trigger automatically for most scenarios (push, pull request, syncโฆ). However, you can optionally change this behavior by modifying the trigger. For example:
- ```yaml
- kind: pipeline
- type: docker
- name: MegaLinter
- workspace:
- path: /tmp/lint
- steps:
- - name: megalinter
- image: ghcr.io/oxsecurity/megalinter:v10
- environment:
- DEFAULT_WORKSPACE: /tmp/lint
- trigger:
- event:
- - push
- ```
- The workflow above triggers only on push, and not in other situations. For more information about configuring Drone CI trigger rules, see the [documentation](https://docs.drone.io/pipeline/triggers/).
- <!-- install-drone-section-end -->
- <!-- install-docker-section-start -->
- <!-- markdown-headers
- ---
- title: Run MegaLinter as a Docker image
- description: Manual instructions to run MegaLinter as a docker image
- ---
- -->
- ### Docker container
- You can also run MegaLinter with its Docker container. Execute this command:
- `docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:rw -v $(pwd):/tmp/lint:rw ghcr.io/oxsecurity/megalinter:v10`
- No extra arguments are needed; however, MegaLinter will lint all files inside the `/tmp/lint` folder. You may need to configure your tool of choice to use `/tmp/lint` as its workspace.
- This can be changed:
- _Example:_
- `docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:rw -v $(pwd):/example/folder:rw ghcr.io/oxsecurity/megalinter:v10`
- <!-- install-docker-section-end -->
- <!-- install-locally-section-start -->
- <!-- markdown-headers
- ---
- title: Run MegaLinter locally on your computer
- description: Manual instructions to run MegaLinter locally on your computer
- ---
- -->
- ### Run MegaLinter locally
- [](https://npmjs.org/package/mega-linter-runner)
- [](https://npmjs.org/package/mega-linter-runner)
- [](https://npmjs.org/package/mega-linter-runner)
- Use [mega-linter-runner](https://megalinter.io/mega-linter-runner/) to run MegaLinter locally with the same configuration defined in your [.mega-linter.yml](https://github.com/oxsecurity/megalinter/tree/main/docs/config-file.md) file.
- See the [mega-linter-runner installation instructions](https://megalinter.io/mega-linter-runner/#installation).
- Example:
- ```shell
- npx mega-linter-runner --flavor salesforce -e "'ENABLE=DOCKERFILE,MARKDOWN,YAML'" -e 'SHOW_ELAPSED_TIME=true'
- ```
- Note: You can also use this command line in your custom CI/CD pipelines.
- <!-- install-locally-section-end -->
- <!-- installation-section-end -->
- <!-- configuration-section-start -->
- <!-- markdown-headers
- ---
- title: MegaLinter configuration Guide
- description: List of all configuration variables that can be used to customize the use of MegaLinter (activation, filtering, auto-update, pre-post commandsโฆ)
- ---
- -->
- ## Configuration
- <!-- config-file-section-start -->
- <!-- markdown-headers
- ---
- title: MegaLinter configuration file
- description: Use config file with auto-completion to customize MegaLinter behaviour
- ---
- -->
- ### .mega-linter.yml file
- MegaLinter configuration variables are defined in a **.mega-linter.yml** file at the root of the repository or with **environment variables**.
- You can see an example config file in this repo: [**.mega-linter.yml**](https://github.com/oxsecurity/megalinter/blob/main/.mega-linter.yml).
- Configuration is assisted with autocompletion and validation in most commonly used IDEs, thanks to the [JSON schema](https://megalinter.io/json-schemas/configuration.html) stored on [schemastore.org](https://www.schemastore.org/).
- - VS Code: You need an extension like [Red Hat YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml).
- - IntelliJ IDEA family: Autocompletion is supported natively.
- You can also define variables as environment variables.
- - If a variable exists in both ENV and the `.mega-linter.yml` file, priority is given to the ENV variable.
- 
- <!-- config-file-section-end -->
- <!-- config-variables-section-start -->
- <!-- markdown-headers
- ---
- title: All Megalinter configuration common variables
- description: List of common variables that you can use to customize MegaLinter behaviour
- ---
- -->
- ### Common variables
- | **ENV VAR** | **Default Value** | **Notes** |
- |---------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- | **ADDITIONAL_EXCLUDED_DIRECTORIES** | \[\] | List of additional excluded directory basenames. They're excluded at any nested level. |
- | [**APPLY_FIXES**](https://github.com/oxsecurity/megalinter/tree/main/docs/config-apply-fixes.md) | `none` | Activates formatting and autofix [(more info)](https://github.com/oxsecurity/megalinter/tree/main/docs/config-apply-fixes.md) |
- | **CLEAR_REPORT_FOLDER** | `false` | Flag to clear files from report folder (usually megalinter-reports) before starting the linting process |
- | **CONFIG_PROPERTIES_TO_APPEND** | \[\] | List of configuration properties to append their values (instead of replacing them) in case of using EXTENDS. |
- | **DEFAULT_BRANCH** | `HEAD` | The name of the repository's default branch, useful if you use VALIDATE_ALL_CODEBASE=false |
- | **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally.
.claude/skills/kibana-dashboards/scripts/kibana-dashboards.js ยท Bundled script ยท 924 lines ยท 1 finding marked
- #!/usr/bin/env node
- /**
- * CRUD operations for Kibana Dashboards and Visualizations using the API.
- *
- * Usage:
- * ./kibana-dashboards.js dashboard get <id> - Get dashboard definition
- * ./kibana-dashboards.js dashboard create <file|-> - Create dashboard
- * ./kibana-dashboards.js dashboard update <id> <file|-> - Update dashboard
- * ./kibana-dashboards.js dashboard upsert <id> <file|-> - Create or update dashboard
- * ./kibana-dashboards.js dashboard delete <id> - Delete dashboard
- *
- * ./kibana-dashboards.js vis list [search] - List Visualizations
- * ./kibana-dashboards.js vis get <id> - Get Visualization
- * ./kibana-dashboards.js vis create <file|-> - Create Visualization
- * ./kibana-dashboards.js vis update <id> <file|-> - Update Visualization
- * ./kibana-dashboards.js vis upsert <id> <file|-> - Create or update Visualization
- * ./kibana-dashboards.js vis delete <id> - Delete Visualization
- *
- * ./kibana-dashboards.js test - Test Kibana connection
- */
- // =============================================================================
- // Stdin Reading
- // =============================================================================
- async function readStdin() {
- return new Promise((resolve, reject) => {
- let data = "";
- process.stdin.setEncoding("utf8");
- if (process.stdin.isTTY) {
- reject(new Error("No input provided via stdin. Use a file path or pipe JSON input."));
- return;
- }
- process.stdin.on("readable", () => {
- let chunk;
- while ((chunk = process.stdin.read()) !== null) {
- data += chunk;
- }
- });
- process.stdin.on("end", () => {
- resolve(data);
- });
- process.stdin.on("error", (err) => {
- reject(err);
- });
- });
- }
- // =============================================================================
- // File System Helpers
- // =============================================================================
- import { readFileSync, existsSync } from "fs";
- async function loadSpec(filePathOrStdin) {
- let content;
- if (filePathOrStdin === "-" || filePathOrStdin === "--stdin") {
- content = await readStdin();
- } else {
- if (!existsSync(filePathOrStdin)) {
- throw new Error(`File not found: ${filePathOrStdin}`);
- }
- content = readFileSync(filePathOrStdin, "utf-8");
- }
- return JSON.parse(content);
- }
- // =============================================================================
- // Kibana Client Setup
- // =============================================================================
- function getKibanaConfig() {
- const cloudId = process.env.KIBANA_CLOUD_ID || process.env.ELASTICSEARCH_CLOUD_ID;
- let url = process.env.KIBANA_URL;
- if (!url && cloudId) {
- try {
- const parts = cloudId.split(":");
- if (parts.length === 2) {
- const decoded = Buffer.from(parts[1], "base64").toString("utf8");
- const decodedParts = decoded.split("$");
- if (decodedParts.length >= 3 && decodedParts[2]) {
- const domain = decodedParts[0];
- const kibanaUuid = decodedParts[2];
- let host = domain;
- let port = "";
- if (domain.includes(":")) {
- const splitDomain = domain.split(":");
- host = splitDomain[0];
- port = `:${splitDomain[1]}`;
- } else {
- port = ":443";
- }
- url = `https://${kibanaUuid}.${host}${port}`;
- }
- }
- } catch (e) {
- console.error("Error parsing Cloud ID:", e.message);
- }
- }
- const username = process.env.KIBANA_USERNAME || process.env.ELASTICSEARCH_USERNAME;
- const password = process.env.KIBANA_PASSWORD || process.env.ELASTICSEARCH_PASSWORD;
- const apiKey = process.env.KIBANA_API_KEY || process.env.ELASTICSEARCH_API_KEY;
- const spaceId = process.env.KIBANA_SPACE_ID;
- const insecure = process.env.KIBANA_INSECURE === "true";
- if (!url) {
- console.error("Error: No Kibana connection configured.");
- console.error("");
- console.error("Set one of these environment variable combinations:");
- console.error(" 1. Elastic Cloud: KIBANA_CLOUD_ID + KIBANA_API_KEY");
- console.error(" 2. URL + API Key: KIBANA_URL + KIBANA_API_KEY");
- console.error(" 3. Basic Auth: KIBANA_URL + KIBANA_USERNAME + KIBANA_PASSWORD");
- console.error("");
- console.error("For local development, use start-local to run Elasticsearch and Kibana via Docker:");
- console.error(" https://github.com/elastic/start-local");
- console.error("");
- console.error(" curl -fsSL https://elastic.co/start-local | sh");
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 129 on GitHub
- console.error("");
- console.error("Then configure the environment:");
- console.error(" source elastic-start-local/.env");
- console.error(' export KIBANA_URL="$KB_LOCAL_URL"');
- console.error(' export KIBANA_USERNAME="elastic"');
- console.error(' export KIBANA_PASSWORD="$ES_LOCAL_PASSWORD"');
- process.exit(1);
- }
- return { url, username, password, apiKey, spaceId, insecure };
- }
- function getHeaders(config) {
- const headers = {
- "Content-Type": "application/json",
- "kbn-xsrf": "true",
- "User-Agent": "elastic-agentic",
- };
- if (config.apiKey) {
- headers["Authorization"] = `ApiKey ${config.apiKey}`;
- } else if (config.username && config.password) {
- const auth = Buffer.from(`${config.username}:${config.password}`).toString("base64");
- headers["Authorization"] = `Basic ${auth}`;
- }
- return headers;
- }
- function getBasePath(config) {
- let basePath = config.url.replace(/\/$/, "");
- if (config.spaceId && config.spaceId !== "default") {
- basePath += `/s/${config.spaceId}`;
- }
- return basePath;
- }
- async function kibanaFetch(path, options = {}) {
- const config = getKibanaConfig();
- const basePath = getBasePath(config);
- const url = `${basePath}${path}`;
- const fetchOptions = {
- ...options,
- headers: {
- ...getHeaders(config),
- ...options.headers,
- },
- };
- // Handle insecure TLS
- if (config.insecure && typeof process !== "undefined") {
- process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
- }
- try {
- const response = await fetch(url, fetchOptions);
- const contentType = response.headers.get("content-type");
- let data;
- if (contentType && contentType.includes("application/json")) {
- data = await response.json();
- } else {
- data = await response.text();
- }
- if (!response.ok) {
- return {
- success: false,
- status: response.status,
- error: data.message || data.error || `HTTP ${response.status}`,
- details: data,
- };
- }
- return { success: true, data };
- } catch (error) {
- return {
- success: false,
- error: error.message,
- details: error,
- };
- }
- }
- // =============================================================================
- // Dashboards API
- // =============================================================================
- /**
- * Get a dashboard by ID
- * GET /api/dashboards/:id (with version header)
- */
- async function getDashboard(id) {
- return kibanaFetch(`/api/dashboards/${encodeURIComponent(id)}`, {
- headers: { "Elastic-Api-Version": "2023-10-31" },
- });
- }
- /**
- * Create a dashboard
- * POST /api/dashboards (with version header)
- * Body: { title, panels, time_range?, ... }
- *
- * Accepts both formats:
- * - Flat: { title, panels, ... }
- * - Wrapped (legacy): { id?, data: { title, panels, ... }, spaces? }
- * The API expects the flat format; this function unwraps if needed.
- * POST does not accept an id parameter. Use PUT for upserts.
- */
- async function createDashboard(definition) {
- const body = definition.data
- ? definition.data
- : (() => {
- const { id, spaces, ...rest } = definition;
- return rest;
- })();
- return kibanaFetch("/api/dashboards", {
- method: "POST",
- headers: { "Elastic-Api-Version": "2023-10-31" },
- body: JSON.stringify(body),
- });
- }
- /**
- * Update a dashboard
- * PUT /api/dashboards/:id (with version header)
- * Body: { title, panels, ... } - do NOT include id or spaces
- *
- * Accepts both formats:
- * - Flat: { title, panels, ... }
- * - Wrapped (legacy): { data: { title, panels, ... } }
- */
- async function updateDashboard(id, definition) {
- const body = definition.data
- ? definition.data
- : (() => {
- const { id: _id, spaces, ...rest } = definition;
- return rest;
- })();
- return kibanaFetch(`/api/dashboards/${encodeURIComponent(id)}`, {
- method: "PUT",
- headers: { "Elastic-Api-Version": "2023-10-31" },
- body: JSON.stringify(body),
- });
- }
- /**
- * Delete a dashboard
- * DELETE /api/dashboards/:id (with version header)
- */
- async function deleteDashboard(id) {
- return kibanaFetch(`/api/dashboards/${encodeURIComponent(id)}`, {
- method: "DELETE",
- headers: { "Elastic-Api-Version": "2023-10-31" },
- });
- }
- // =============================================================================
- // Visualizations API
- // =============================================================================
- /**
- * List Visualizations
- * GET /api/visualizations?query=&page=&per_page=
- */
- async function listVisualizations(query = "", page = 1, per_page = 100) {
- const params = new URLSearchParams({ page: String(page), per_page: String(per_page) });
- if (query) {
- params.set("query", query);
- }
- return kibanaFetch(`/api/visualizations?${params.toString()}`, {
- headers: { "Elastic-Api-Version": "2023-10-31" },
- });
- }
- /**
- * Get a Visualization by ID
- * GET /api/visualizations/:id
- */
- async function getVisualization(id) {
- return kibanaFetch(`/api/visualizations/${id}`, {
- headers: { "Elastic-Api-Version": "2023-10-31" },
- });
- }
- /**
- * Create a Visualization
- * POST /api/visualizations
- * Body: visualization definition (without id)
- */
- async function createVisualization(definition) {
- return kibanaFetch("/api/visualizations", {
- method: "POST",
- headers: { "Elastic-Api-Version": "2023-10-31" },
- body: JSON.stringify(definition),
- });
- }
- /**
- * Update a Visualization
- * PUT /api/visualizations/:id
- * Body: visualization definition
- */
- async function updateVisualization(id, definition) {
- return kibanaFetch(`/api/visualizations/${id}`, {
- method: "PUT",
- headers: { "Elastic-Api-Version": "2023-10-31" },
- body: JSON.stringify(definition),
- });
- }
- /**
- * Delete a Visualization
- * DELETE /api/visualizations/:id
- */
- async function deleteVisualization(id) {
- return kibanaFetch(`/api/visualizations/${id}`, {
- method: "DELETE",
- headers: { "Elastic-Api-Version": "2023-10-31" },
- });
- }
- // =============================================================================
- // Test Connection
- // =============================================================================
- function parseVersion(versionString) {
- if (!versionString) return { major: 0, minor: 0, patch: 0, snapshot: false, raw: "unknown" };
- const clean = versionString.replace(/-SNAPSHOT.*$/, "");
- const [major, minor, patch] = clean.split(".").map(Number);
- return { major, minor, patch: patch || 0, snapshot: versionString.includes("-SNAPSHOT"), raw: versionString };
- }
- async function testConnection() {
- const result = await kibanaFetch("/api/status");
- if (result.success) {
- const status = result.data;
- const versionString = status.version?.number || "unknown";
- const buildFlavor = status.version?.build_flavor || "default";
- // Serverless Kibana can be identified by build_flavor or a non-semver version string
- const isSemver = /^\d+\.\d+\.\d+/.test(versionString);
- const isServerless = buildFlavor === "serverless" || (!isSemver && versionString !== "unknown");
- const parsed = isSemver ? parseVersion(versionString) : parseVersion("8.11.0");
- return {
- success: true,
- version: isServerless && !isSemver ? `${versionString} (Serverless)` : versionString,
- parsed,
- buildFlavor: isServerless ? "serverless" : buildFlavor,
- isServerless,
- status: status.status?.overall?.level || "unknown",
- name: status.name || "unknown",
- };
- }
- return result;
- }
- // =============================================================================
- // Output Formatting
- // =============================================================================
- function formatDashboard(item) {
- const lines = [];
- lines.push("=== Dashboard ===");
- lines.push(`ID: ${item.id}`);
- if (item.spaces && item.spaces.length > 0) {
- lines.push(`Spaces: ${item.spaces.join(", ")}`);
- }
- if (item.meta) {
- lines.push(`Created: ${item.meta.created_at || "unknown"}`);
- lines.push(`Updated: ${item.meta.updated_at || "unknown"}`);
- lines.push(`Managed: ${item.meta.managed || false}`);
- }
- if (item.data) {
- lines.push(`Title: ${item.data.title || "Untitled"}`);
- lines.push(`Panels: ${item.data.panels?.length || 0}`);
- if (item.data.time_range) {
- lines.push(`Time Range: ${item.data.time_range.from} to ${item.data.time_range.to}`);
- }
- }
- lines.push("\n--- Definition (data) ---");
- lines.push(JSON.stringify(item.data, null, 2));
- return lines.join("\n");
- }
- function formatVisList(response) {
- const items = response.data || [];
- const meta = response.meta || {};
- if (!items || items.length === 0) {
- return "No Visualizations found.";
- }
- const lines = ["ID".padEnd(40) + " | " + "Type".padEnd(15) + " | " + "Title"];
- lines.push("-".repeat(40) + "-+-" + "-".repeat(15) + "-+-" + "-".repeat(40));
- for (const item of items) {
- const id = item.id || "unknown";
- const type = item.data?.type || "unknown";
- const title = item.data?.title || "Untitled";
- lines.push(`${id.substring(0, 40).padEnd(40)} | ${type.padEnd(15)} | ${title}`);
- }
- lines.push("");
- lines.push(
- `Page ${meta.page || 1} | Per Page: ${meta.per_page || items.length} | Total: ${meta.total || items.length}`,
- );
- return lines.join("\n");
- }
- function formatVisualization(item) {
- const lines = [];
- lines.push("=== Visualization ===");
- lines.push(`ID: ${item.id}`);
- if (item.meta) {
- lines.push(`Created: ${item.meta.created_at || "unknown"}`);
- lines.push(`Updated: ${item.meta.updated_at || "unknown"}`);
- lines.push(`Managed: ${item.meta.managed || false}`);
- }
- lines.push("\n--- Definition (data) ---");
- lines.push(JSON.stringify(item.data, null, 2));
- return lines.join("\n");
- }
- // =============================================================================
- // Main CLI
- // =============================================================================
- async function main() {
- const args = process.argv.slice(2);
- if (args.length === 0 || args[0] === "help" || args[0] === "--help" || args[0] === "-h") {
- printUsage();
- process.exit(args.length === 0 ? 1 : 0);
- }
- const [resource, action, ...params] = args;
- try {
- switch (resource) {
- case "test":
- await handleTest();
- break;
- case "dashboard":
- case "dashboards":
- case "dash":
- await handleDashboard(action, params);
- break;
- case "vis":
- await handleVis(action, params);
- break;
- default:
- console.error(`Unknown resource: ${resource}`);
- printUsage();
- process.exit(1);
- }
- } catch (error) {
- console.error("Error:", error.message);
- process.exit(1);
- }
- }
- async function handleTest() {
- console.log("=== Testing Kibana Connection ===\n");
- const result = await testConnection();
- if (result.success) {
- const { parsed, isServerless, buildFlavor } = result;
- const { major, minor } = parsed;
- console.log("โ Connected successfully!");
- console.log(` Name: ${result.name}`);
- console.log(` Version: ${result.version}`);
- console.log(` Build flavor: ${buildFlavor}`);
- if (parsed.snapshot) console.log(` Snapshot: yes (treating as ${major}.${minor})`);
- if (isServerless) console.log(" NOTE: Serverless โ features available regardless of reported version");
- console.log(` Status: ${result.status}`);
- // Check if Dashboards API is available
- console.log("\n=== Dashboards API Check ===");
- // Try to get a non-existent dashboard - 404 means API is available
- const dashResult = await getDashboard("__test_nonexistent__");
- if (dashResult.success || dashResult.status === 404) {
- console.log("โ Dashboards API is available");
- } else if (dashResult.status === 400) {
- console.log("โ Dashboards API may not be available in this version");
- } else {
- console.log("โ Dashboards API check failed:", dashResult.error);
- }
- // Check if Visualizations API is available
- console.log("\n=== Visualizations API Check ===");
- const visResult = await listVisualizations("", 1, 1);
- if (visResult.success) {
- console.log("โ Visualizations API is available");
- } else {
- console.log("โ Visualizations API check failed:", visResult.error);
- }
- } else {
- console.error("โ Connection failed:", result.error);
- if (result.details) {
- console.error("Details:", JSON.stringify(result.details, null, 2));
- }
- process.exit(1);
- }
- }
- async function handleDashboard(action, params) {
- switch (action) {
- case "get": {
- const id = params[0];
- if (!id) {
- console.error("Error: Dashboard ID required");
- console.error("Usage: ./kibana-dashboards.js dashboard get <id>");
- process.exit(1);
- }
- const result = await getDashboard(id);
- if (result.success) {
- console.log(formatDashboard(result.data));
- } else {
- console.error("Error:", result.error);
- process.exit(1);
- }
- break;
- }
- case "create": {
- const file = params[0];
- if (!file) {
- console.error("Error: Definition file/stdin required");
- console.error("Usage: ./kibana-dashboards.js dashboard create <file.json>");
- console.error(
- ' echo \'{"title":"My Dashboard","panels":[]}\' | ./kibana-dashboards.js dashboard create -',
- );
- process.exit(1);
- }
- const definition = await loadSpec(file);
- const result = await createDashboard(definition);
- if (result.success) {
- console.log("โ Dashboard created successfully!");
- console.log(` ID: ${result.data.id}`);
- console.log(` Title: ${result.data.data?.title || "Untitled"}`);
- console.log(` Panels: ${result.data.data?.panels?.length || 0}`);
- if (result.data.spaces) {
- console.log(` Spaces: ${result.data.spaces.join(", ")}`);
- }
- } else {
- console.error("Error:", result.error);
- if (result.details) {
- console.error("Details:", JSON.stringify(result.details, null, 2));
- }
- process.exit(1);
- }
- break;
- }
- case "update": {
- const id = params[0];
- const file = params[1];
- if (!id || !file) {
- console.error("Error: Dashboard ID and definition file/stdin required");
- console.error("Usage: ./kibana-dashboards.js dashboard update <id> <file.json>");
- console.error(
- ' echo \'{"title":"Updated","panels":[...]}\' | ./kibana-dashboards.js dashboard update <id> -',
- );
- process.exit(1);
- }
- const definition = await loadSpec(file);
- const result = await updateDashboard(id, definition);
- if (result.success) {
- console.log("โ Dashboard updated successfully!");
- console.log(` ID: ${result.data.id}`);
- console.log(` Title: ${result.data.data?.title || "Untitled"}`);
- } else {
- console.error("Error:", result.error);
- if (result.details) {
- console.error("Details:", JSON.stringify(result.details, null, 2));
- }
- process.exit(1);
- }
- break;
- }
- case "upsert": {
- const id = params[0];
- const file = params[1];
- if (!id || !file) {
- console.error("Error: Dashboard ID and definition file/stdin required");
- console.error("Usage: ./kibana-dashboards.js dashboard upsert <id> <file.json>");
- process.exit(1);
- }
- const definition = await loadSpec(file);
- const result = await updateDashboard(id, definition);
- if (result.success) {
- console.log("โ Dashboard upserted successfully!");
- console.log(` ID: ${result.data.id}`);
- console.log(` Title: ${result.data.data?.title || "Untitled"}`);
- } else {
- console.error("Error:", result.error);
- if (result.details) {
- console.error("Details:", JSON.stringify(result.details, null, 2));
- }
- process.exit(1);
- }
- break;
- }
- case "delete":
- case "rm": {
- const id = params[0];
- if (!id) {
- console.error("Error: Dashboard ID required");
- console.error("Usage: ./kibana-dashboards.js dashboard delete <id>");
- process.exit(1);
- }
- const result = await deleteDashboard(id);
- if (result.success) {
- console.log("โ Dashboard deleted successfully!");
- } else {
- console.error("Error:", result.error);
- process.exit(1);
- }
- break;
- }
- default:
- console.error(`Unknown dashboard action: ${action}`);
- console.error("Available actions: get, create, update, upsert, delete");
- process.exit(1);
- }
- }
- async function handleVis(action, params) {
- switch (action) {
- case "list":
- case "ls": {
- const query = params[0] || "";
- const result = await listVisualizations(query);
- if (result.success) {
- console.log("=== Visualizations ===\n");
- console.log(formatVisList(result.data));
- } else {
- console.error("Error:", result.error);
- process.exit(1);
- }
- break;
- }
- case "get": {
- const id = params[0];
- if (!id) {
- console.error("Error: Visualization ID required");
- console.error("Usage: ./kibana-dashboards.js vis get <id>");
- process.exit(1);
- }
- const result = await getVisualization(id);
- if (result.success) {
- console.log(formatVisualization(result.data));
- } else {
- console.error("Error:", result.error);
- process.exit(1);
- }
- break;
- }
- case "create": {
- const file = params[0];
- if (!file) {
- console.error("Error: Definition file/stdin required");
- console.error("Usage: ./kibana-dashboards.js vis create <file.json>");
- console.error(' echo \'{"type":"metric",...}\' | ./kibana-dashboards.js vis create -');
- process.exit(1);
- }
- const definition = await loadSpec(file);
- const result = await createVisualization(definition);
- if (result.success) {
- console.log("โ Visualization created successfully!");
- console.log(` ID: ${result.data.id}`);
- console.log(` Type: ${result.data.data?.type || "unknown"}`);
- } else {
- console.error("Error:", result.error);
- if (result.details) {
- console.error("Details:", JSON.stringify(result.details, null, 2));
- }
- process.exit(1);
- }
- break;
- }
- case "update": {
- const id = params[0];
- const file = params[1];
- if (!id || !file) {
- console.error("Error: Visualization ID and definition file/stdin required");
- console.error("Usage: ./kibana-dashboards.js vis update <id> <file.json>");
- console.error(' echo \'{"type":"metric",...}\' | ./kibana-dashboards.js vis update <id> -');
- process.exit(1);
- }
- const definition = await loadSpec(file);
- const result = await updateVisualization(id, definition);
- if (result.success) {
- console.log("โ Visualization updated successfully!");
- console.log(` ID: ${result.data.id}`);
- } else {
- console.error("Error:", result.error);
- if (result.details) {
- console.error("Details:", JSON.stringify(result.details, null, 2));
- }
- process.exit(1);
- }
- break;
- }
- case "upsert": {
- const id = params[0];
- const file = params[1];
- if (!id || !file) {
- console.error("Error: Visualization ID and definition file/stdin required");
- console.error("Usage: ./kibana-dashboards.js vis upsert <id> <file.json>");
- process.exit(1);
- }
- const definition = await loadSpec(file);
- const result = await updateVisualization(id, definition);
- if (result.success) {
- console.log("โ Visualization upserted successfully!");
- console.log(` ID: ${result.data.id}`);
- } else {
- console.error("Error:", result.error);
- if (result.details) {
- console.error("Details:", JSON.stringify(result.details, null, 2));
- }
- process.exit(1);
- }
- break;
- }
- case "delete":
- case "rm": {
- const id = params[0];
- if (!id) {
- console.error("Error: Visualization ID required");
- console.error("Usage: ./kibana-dashboards.js vis delete <id>");
- process.exit(1);
- }
- const result = await deleteVisualization(id);
- if (result.success) {
- console.log("โ Visualization deleted successfully!");
- } else {
- console.error("Error:", result.error);
- process.exit(1);
- }
- break;
- }
- default:
- console.error(`Unknown vis action: ${action}`);
- console.error("Available actions: list, get, create, update, upsert, delete");
- process.exit(1);
- }
- }
- function printUsage() {
- console.log(`
- Kibana as Code - Dashboards & Visualizations API
- Usage:
- ./kibana-dashboards.js <resource> <action> [options]
- Resources:
- dashboard Manage dashboards via API
- vis Manage visualizations via API
- test Test Kibana connection and API availability
- Dashboard Actions:
- get <id> Get dashboard definition
- create <file|-> Create from JSON file (use - for stdin)
- update <id> <file|-> Update from JSON file (use - for stdin)
- upsert <id> <file|-> Create or update (use - for stdin)
- delete <id> Delete dashboard
- Visualization Actions:
- list [search] List Visualizations (optional search)
- get <id> Get visualization definition
- create <file|-> Create from JSON file (use - for stdin)
- update <id> <file|-> Update from JSON file (use - for stdin)
- upsert <id> <file|-> Create or update (use - for stdin)
- delete <id> Delete visualization
- Environment Variables:
- KIBANA_CLOUD_ID Elastic Cloud deployment ID (if KIBANA_URL is not set)
- KIBANA_URL Kibana URL (required if KIBANA_CLOUD_ID is not set)
- KIBANA_USERNAME Username for basic auth
- KIBANA_PASSWORD Password for basic auth
- KIBANA_API_KEY API key for authentication
- KIBANA_SPACE_ID Kibana space ID (optional)
- KIBANA_INSECURE Set to "true" to skip TLS verification
- Dashboard Panel Types:
- vis Visualization panel
- markdown Markdown panel
- links Links panel
- map Maps panel
- discover_session Saved search panel
- (and more embeddable types)
- Chart Types:
- metric, xy, gauge, heatmap, tag_cloud,
- region_map, data_table, pie, treemap, mosaic, waffle
- Examples:
- # Test connection and API availability
- ./kibana-dashboards.js test
- # Get a dashboard definition
- ./kibana-dashboards.js dashboard get my-dashboard-id
- # Create a dashboard from file
- ./kibana-dashboards.js dashboard create ./my-dashboard.json
- # Create a dashboard from stdin
- echo '{"title":"Test","panels":[]}' | \\
- ./kibana-dashboards.js dashboard create -
- # Update a dashboard (do not include id/spaces in body)
- echo '{"title":"Updated Title","panels":[]}' | \\
- ./kibana-dashboards.js dashboard update my-dashboard-id -
- # Delete a dashboard
- ./kibana-dashboards.js dashboard delete my-dashboard-id
- # List all Visualizations
- ./kibana-dashboards.js vis list
- # Create metric visualization from stdin
- echo '{"type":"metric","data_source":{"type":"esql","query":"FROM logs | STATS count=COUNT()"},"metrics":[{"type":"primary","column":"count"}]}' | \\
- ./kibana-dashboards.js vis create -
- # Copy dashboard: get from source, create on destination
- ./kibana-dashboards.js dashboard get source-id > dashboard.json
- # Edit dashboard.json as needed, then create
- ./kibana-dashboards.js dashboard create dashboard.json
- `);
- }
- main().catch((error) => {
- console.error("Fatal error:", error.message);
- process.exit(1);
- });
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If itโs helped, pass it on.