Forrest logo
tool overview
On this page you find all important commands for the CLI tool phpmd. If the command you are looking for is missing please ask our AI.

phpmd

This is the project site of PHPMD. It is a spin-off project of PHP Depend and aims to be a PHP equivalent of the well known Java tool PMD. PHPMD can be seen as an user friendly and easy to configure frontend for the raw metrics measured by PHP Depend.

What PHPMD does is: It takes a given PHP source code base and look for several potential problems within that source.

List of commands for phpmd:

  • phpmd:help phpmd: Display a list of available rulesets and formats.
    $ phpmd
    try on your machine
    explain this command
  • phpmd:tldr:0302d phpmd: Include only the specified extensions in analysis.
    $ phpmd ${filename_or_directory} ${xml|text|html} ${rulesets} --suffixes ${extensions}
    try on your machine
    explain this command
  • phpmd:tldr:033b7 phpmd: Exclude the specified comma-separated directories.
    $ phpmd ${filename_or_directory} ${xml|text|html} ${rulesets} --exclude ${directory_patterns}
    try on your machine
    explain this command
  • phpmd:tldr:1e85e phpmd: Specify the minimum priority threshold for rules.
    $ phpmd ${filename_or_directory} ${xml|text|html} ${rulesets} --minimumpriority ${priority}
    try on your machine
    explain this command
  • phpmd:tldr:23f4e phpmd: Ignore the use of warning-suppressive PHPDoc comments.
    $ phpmd ${filename_or_directory} ${xml|text|html} ${rulesets} --strict
    try on your machine
    explain this command
  • phpmd:tldr:6c1fb phpmd: Scan a file or directory for problems using comma-separated rulesets.
    $ phpmd ${filename_or_directory} ${xml|text|html} ${rulesets}
    try on your machine
    explain this command
  • phpmd:tldr:f767d phpmd: Output the results to a file instead of `stdout`.
    $ phpmd ${filename_or_directory} ${xml|text|html} ${rulesets} --reportfile ${path-to-report_file}
    try on your machine
    explain this command
tool overview