.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PHPUNIT "1" "April 2024" "phpunit 11.1.2" "User Commands"
.SH NAME
phpunit \- PHPUnit command line interface
.SH SYNOPSIS
.B phpunit
[\fI\,options\/\fR] \fI\,<directory|file> \/\fR...
.SH DESCRIPTION
Configuration:
.TP
\fB\-\-bootstrap\fR <file>
A PHP script that is included before the tests run
.TP
\fB\-c\fR|\-\-configuration <file>
Read configuration from XML file
.TP
\fB\-\-no\-configuration\fR
Ignore default configuration file (phpunit.xml)
.TP
\fB\-\-no\-extensions\fR
Do not load PHPUnit extensions
.TP
\fB\-\-include\-path\fR <path(s)>
Prepend PHP's include_path with given path(s)
.TP
\fB\-d\fR <key[=value]>
Sets a php.ini value
.TP
\fB\-\-cache\-directory\fR <dir>
Specify cache directory
.TP
\fB\-\-generate\-configuration\fR
Generate configuration file with suggested settings
.TP
\fB\-\-migrate\-configuration\fR
Migrate configuration file to current format
.TP
\fB\-\-generate\-baseline\fR <file>
Generate baseline for issues
.TP
\fB\-\-use\-baseline\fR <file>
Use baseline to ignore issues
.TP
\fB\-\-ignore\-baseline\fR
Do not use baseline to ignore issues
.PP
Selection:
.TP
\fB\-\-list\-suites\fR
List available test suites
.TP
\fB\-\-testsuite\fR <name>
Only run tests from the specified test suite(s)
.TP
\fB\-\-exclude\-testsuite\fR <name>
Exclude tests from the specified test suite(s)
.TP
\fB\-\-list\-groups\fR
List available test groups
.TP
\fB\-\-group\fR <name>
Only run tests from the specified group(s)
.TP
\fB\-\-exclude\-group\fR <name>
Exclude tests from the specified group(s)
.TP
\fB\-\-covers\fR <name>
Only run tests that intend to cover <name>
.TP
\fB\-\-uses\fR <name>
Only run tests that intend to use <name>
.TP
\fB\-\-list\-test\-files\fR
List available test files
.TP
\fB\-\-list\-tests\fR
List available tests
.TP
\fB\-\-list\-tests\-xml\fR <file>
List available tests in XML format
.TP
\fB\-\-filter\fR <pattern>
Filter which tests to run
.TP
\fB\-\-exclude\-filter\fR <pattern>
Exclude tests for the specified filter pattern
.TP
\fB\-\-test\-suffix\fR <suffixes>
Only search for test in files with specified suffix(es). Default: Test.php,.phpt
.PP
Execution:
.TP
\fB\-\-process\-isolation\fR
Run each test in a separate PHP process
.TP
\fB\-\-globals\-backup\fR
Backup and restore $GLOBALS for each test
.TP
\fB\-\-static\-backup\fR
Backup and restore static properties for each test
.TP
\fB\-\-strict\-coverage\fR
Be strict about code coverage metadata
.TP
\fB\-\-strict\-global\-state\fR
Be strict about changes to global state
.TP
\fB\-\-disallow\-test\-output\fR
Be strict about output during tests
.TP
\fB\-\-enforce\-time\-limit\fR
Enforce time limit based on test size
.TP
\fB\-\-default\-time\-limit\fR <sec>
Timeout in seconds for tests that have no declared size
.TP
\fB\-\-dont\-report\-useless\-tests\fR
Do not report tests that do not test anything
.TP
\fB\-\-stop\-on\-defect\fR
Stop after first error, failure, warning, or risky test
.TP
\fB\-\-stop\-on\-error\fR
Stop after first error
.TP
\fB\-\-stop\-on\-failure\fR
Stop after first failure
.TP
\fB\-\-stop\-on\-warning\fR
Stop after first warning
.TP
\fB\-\-stop\-on\-risky\fR
Stop after first risky test
.TP
\fB\-\-stop\-on\-deprecation\fR
Stop after first test that triggered a deprecation
.TP
\fB\-\-stop\-on\-notice\fR
Stop after first test that triggered a notice
.TP
\fB\-\-stop\-on\-skipped\fR
Stop after first skipped test
.TP
\fB\-\-stop\-on\-incomplete\fR
Stop after first incomplete test
.TP
\fB\-\-fail\-on\-empty\-test\-suite\fR
Signal failure using shell exit code when no tests were run
.TP
\fB\-\-fail\-on\-warning\fR
Signal failure using shell exit code when a warning was triggered
.TP
\fB\-\-fail\-on\-risky\fR
Signal failure using shell exit code when a test was considered risky
.TP
\fB\-\-fail\-on\-deprecation\fR
Signal failure using shell exit code when a deprecation was triggered
.TP
\fB\-\-fail\-on\-notice\fR
Signal failure using shell exit code when a notice was triggered
.TP
\fB\-\-fail\-on\-skipped\fR
Signal failure using shell exit code when a test was skipped
.TP
\fB\-\-fail\-on\-incomplete\fR
Signal failure using shell exit code when a test was marked incomplete
.TP
\fB\-\-cache\-result\fR
Write test results to cache file
.TP
\fB\-\-do\-not\-cache\-result\fR
Do not write test results to cache file
.TP
\fB\-\-order\-by\fR <order>
Run tests in order: default|defects|depends|duration|no\-depends|random|reverse|size
.TP
\fB\-\-random\-order\-seed\fR <N>
Use the specified random seed when running tests in random order
.PP
Reporting:
.TP
\fB\-\-colors\fR <flag>
Use colors in output ("never", "auto" or "always")
.TP
\fB\-\-columns\fR <n>
Number of columns to use for progress output
.TP
\fB\-\-columns\fR max
Use maximum number of columns for progress output
.TP
\fB\-\-stderr\fR
Write to STDERR instead of STDOUT
.TP
\fB\-\-no\-progress\fR
Disable output of test execution progress
.TP
\fB\-\-no\-results\fR
Disable output of test results
.TP
\fB\-\-no\-output\fR
Disable all output
.TP
\fB\-\-display\-incomplete\fR
Display details for incomplete tests
.TP
\fB\-\-display\-skipped\fR
Display details for skipped tests
.TP
\fB\-\-display\-deprecations\fR
Display details for deprecations triggered by tests
.TP
\fB\-\-display\-errors\fR
Display details for errors triggered by tests
.TP
\fB\-\-display\-notices\fR
Display details for notices triggered by tests
.TP
\fB\-\-display\-warnings\fR
Display details for warnings triggered by tests
.TP
\fB\-\-reverse\-list\fR
Print defects in reverse order
.TP
\fB\-\-teamcity\fR
Replace default progress and result output with TeamCity format
.TP
\fB\-\-testdox\fR
Replace default result output with TestDox format
.TP
\fB\-\-debug\fR
Replace default progress and result output with debugging information
.PP
Logging:
.TP
\fB\-\-log\-junit\fR <file>
Write test results in JUnit XML format to file
.TP
\fB\-\-log\-teamcity\fR <file>
Write test results in TeamCity format to file
.TP
\fB\-\-testdox\-html\fR <file>
Write test results in TestDox format (HTML) to file
.TP
\fB\-\-testdox\-text\fR <file>
Write test results in TestDox format (plain text) to file
.TP
\fB\-\-log\-events\-text\fR <file>
Stream events as plain text to file
.TP
\fB\-\-log\-events\-verbose\-text\fR <file>
Stream events as plain text with extended information to file
.TP
\fB\-\-no\-logging\fR
Ignore logging configured in the XML configuration file
.PP
Code Coverage:
.TP
\fB\-\-coverage\-clover\fR <file>
Write code coverage report in Clover XML format to file
.TP
\fB\-\-coverage\-cobertura\fR <file>
Write code coverage report in Cobertura XML format to file
.TP
\fB\-\-coverage\-crap4j\fR <file>
Write code coverage report in Crap4J XML format to file
.TP
\fB\-\-coverage\-html\fR <dir>
Write code coverage report in HTML format to directory
.TP
\fB\-\-coverage\-php\fR <file>
Write serialized code coverage data to file
.TP
\fB\-\-coverage\-text=\fR<file>
Write code coverage report in text format to file [default: standard output]
.TP
\fB\-\-only\-summary\-for\-coverage\-text\fR
Option for code coverage report in text format: only show summary
.HP
\fB\-\-show\-uncovered\-for\-coverage\-text\fR Option for code coverage report in text format: show uncovered files
.TP
\fB\-\-coverage\-xml\fR <dir>
Write code coverage report in XML format to directory
.TP
\fB\-\-warm\-coverage\-cache\fR
Warm static analysis cache
.TP
\fB\-\-coverage\-filter\fR <dir>
Include <dir> in code coverage reporting
.TP
\fB\-\-path\-coverage\fR
Report path coverage in addition to line coverage
.TP
\fB\-\-disable\-coverage\-ignore\fR
Disable metadata for ignoring code coverage
.TP
\fB\-\-no\-coverage\fR
Ignore code coverage reporting configured in the XML configuration file
.PP
Miscellaneous:
.TP
\fB\-h\fR|\-\-help
Prints this usage information
.TP
\fB\-\-version\fR
Prints the version and exits
.TP
\fB\-\-atleast\-version\fR <min>
Checks that version is greater than <min> and exits
.TP
\fB\-\-check\-version\fR
Checks whether PHPUnit is the latest version and exits