.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH PHPMD "1" "September 2022" "PHPMD 2.13.0" "User Commands"
.SH NAME
PHPMD \- PHPMD command line interface
.SH DESCRIPTION
Mandatory arguments:
1) A php source code filename or directory. Can be a comma\-separated string
2) A report format
3) A ruleset filename or a comma\-separated string of rulesetfilenames
.PP
Example: phpmd \fI\,/path/to/source\/\fP format ruleset
.PP
Available formats: ansi, baseline, checkstyle, github, gitlab, html, json, sarif, text, xml.
Available rulesets: cleancode, codesize, controversial, design, naming, unusedcode.
.PP
Optional arguments that may be put after the mandatory arguments:
\fB\-\-minimumpriority\fR: rule priority threshold; rules with lower priority than this will not be used
\fB\-\-reportfile\fR: send report output to a file; default to STDOUT
\fB\-\-suffixes\fR: comma\-separated string of valid source code filename extensions, e.g. php,phtml
\fB\-\-exclude\fR: comma\-separated string of patterns that are used to ignore directories. Use asterisks to exclude by pattern. For example *src/foo/*.php or *src/foo/*
\fB\-\-strict\fR: also report those nodes with a @SuppressWarnings annotation
\fB\-\-ignore\-errors\-on\-exit\fR: will exit with a zero code, even on error
\fB\-\-ignore\-violations\-on\-exit\fR: will exit with a zero code, even if any violations are found
\fB\-\-generate\-baseline\fR: will generate a phpmd.baseline.xml next to the first ruleset file location
\fB\-\-update\-baseline\fR: will remove any non\-existing violations from the phpmd.baseline.xml
\fB\-\-baseline\-file\fR: a custom location of the baseline file