megalinter command
1. Help
Command: bin/megalinter --help
Run MegaLinter for comprehensive code quality checks.
SYNOPSIS:
Run megalinter over this repository.
USAGE: megalinter [OPTIONS]
USAGE: megalinter [--help|-h] [--config]
[--bash-framework-config <bash-framework-config>] [--verbose|-v] [-vv] [-vvv]
[--log-level <log-level>] [--log-file <log-file>]
[--display-level <display-level>] [--no-color] [--theme <theme>] [--version]
[--quiet|-q] [--format <<Format>>] [--fix] [--filesOnly] [--incremental|-i]
[--image <<ImageName>>] [--config-file <<ConfigFile>>]
[--check-megalinter-version]
GLOBAL OPTIONS:
--help, -h {single}
Displays this command help
--config {single}
Displays configuration
--bash-framework-config <bash-framework-config> {single}
Use alternate bash framework configuration.
--verbose, -v {single}
Info level verbose mode (alias of --display-level INFO)
-vv {single}
Debug level verbose mode (alias of --display-level DEBUG)
-vvv {single}
Trace level verbose mode (alias of --display-level TRACE)
--log-level <log-level> {single}
Set log level
Possible values:
- OFF
- ERR
- ERROR
- WARN
- WARNING
- INFO
- DEBUG
- TRACE
Default value: OFF
--log-file <log-file> {single}
Set log file
Default value: /bash/logs/megalinter.log
--display-level <display-level> {single}
Set display level
Possible values:
- OFF
- ERR
- ERROR
- WARN
- WARNING
- INFO
- DEBUG
- TRACE
Default value: INFO
--no-color {single}
Produce monochrome output. alias of --theme noColor.
--theme <theme> {single}
Choose color theme - default-force means colors will be produced even if
command is piped.
Possible values:
- default
- default-force
- noColor
Default value: default
--version {single}
Print version information and quit.
--quiet, -q {single}
Quiet mode, doesn't display any output.
OPTIONS:
--format <<Format>> {single}
Define output format of this command.
Possible values:
- plain
- json
Default value: plain
--fix {single}
Apply linters fixes automatically.
--filesOnly {single}
Skip linters that run in project mode.
--incremental, -i {single}
Run megalinter only on files that are git staged.
--image <<ImageName>> {single}
Specify docker megalinter image name to use.
Default value: oxsecurity/megalinter-terraform:v9
--config-file <<ConfigFile>> {single}
Specify megalinter config filename to use.
Default value: .mega-linter.yml
--check-megalinter-version {single}
Check if new version of megalinter is available (compared to default ima
ge). Exits 1 if yes and displays new version number.
DESCRIPTION:
megalinter image will be used.
<files> optionally you can provide a list of files to run megalinter on
this mode is incompatible with --incremental option.
VERSION: 3.0
AUTHOR: [François Chastanet](https://github.com/fchastanet)
SOURCE FILE: https://github.com/fchastanet/bash-tools-framework/tree/master/src/_binaries/megalinter/megalinter-binary.yaml
LICENSE: MIT License
Copyright (c) 2023-now François Chastanet