Documentation for the checkers command
@@ -477,16 +477,74 @@ optional arguments:
-s, --steps Print steps.
~~~~~~~~~~~~~~~~~~~~~
-## 4. checkers mode:
+## 4. `checkers` mode
-List all available checkers.
+List the checkers available in the installed analyzers which can be used when
+performing an analysis.
-The ```+``` (or ```-```) sign before a name of a checker shows whether the checker is enabled (or disabled) by default.
+### Old `CodeChecker checkers` command
+
+The ```+``` (or ```-```) sign before a name of a checker shows whether the
+checker is enabled (or disabled) by default.
~~~~~~~~~~~~~~~~~~~~~
-CodeChecker checkers
+usage: CodeChecker checkers [-h] [--analyzers ANALYZERS [ANALYZERS ...]]
+ [--verbose {info,debug,debug_analyzer}]
+
+optional arguments:
+ -h, --help show this help message and exit
+ --analyzers ANALYZERS [ANALYZERS ...]
+ Select which analyzer checkers should be listed.
+ Currently supported analyzers: clangsa clang-tidy
+ (default: None)
+ --verbose {info,debug,debug_analyzer}
+ Set verbosity level. (default: info)
+~~~~~~~~~~~~~~~~~~~~~
+
+### New `codechecker-checkers` command
+
+By default, `codechecker-checkers` will list all checkers, one per each row,
+providing a quick overview on which checkers are available in the analyzers.
+
+~~~~~~~~~~~~~~~~~~~~~
+usage: codechecker-checkers [-h] [--analyzers ANALYZER [ANALYZER ...]]
+ [--details] [--only-enabled | --only-disabled]
+ [-o {rows,table,csv,json}]
+ [--verbose {info,debug,debug_analyzer}]
+
+Get the list of checkers available and their enabled status in the supported
+analyzers. Currently supported analyzers are: clangsa, clang-tidy.
+
+optional arguments:
+ -h, --help show this help message and exit
+ --analyzers ANALYZER [ANALYZER ...]
+ Show checkers only from the analyzers specified.
+ --details Show details about the checker, such as description,
+ if available. (default: False)
+ --only-enabled Show only the enabled checkers. (default: False)
+ --only-disabled Show only the disabled checkers. (default: False)
+ -o {rows,table,csv,json}, --output {rows,table,csv,json}
+ The format to list the applicable checkers as.
+ (default: rows)
+ --verbose {info,debug,debug_analyzer}
+ Set verbosity level. (default: info)
~~~~~~~~~~~~~~~~~~~~~
+The list provided by default is formatted for easy machine and human
+reading. Use the `--only-` options (`--only-enabled` and `--only-disabled`) to
+filter the list if you wish to see just the enabled/disabled checkers.
+
+A detailed view of the available checkers is available via `--details`. In the
+*detailed view*, checker status, severity and description (if available) is
+also printed.
+
+A machine-readable `csv` or `json` output can be generated by supplying the
+`--output csv` or `--output json` argument.
+
+The _default_ list of enabled and disabled checkers can be altered by editing
+`{INSTALL_DIR}/config/config.json`. Note, that this file is overwritten when
+the package is reinstalled!
+
## 5. `analyzers` mode
List the available and supported analyzers installed on the system. This command
@@ -518,9 +576,6 @@ optional arguments:
A detailed view of the available analyzers is available via `--details`. In the
*detailed view*, version string and install path is also printed.
-A machine-readable `csv` or `json` output can be generated by supplying the
-`--output csv` or `--output json` argument.
-
## 5. cmd mode:
A lightweigh command line interface to query the results of an analysis.
