.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PHPUNIT "1" "April 2024" "phpunit 9.6.19" "User Commands"
.SH NAME
phpunit \- PHPUnit command line interface
.SH SYNOPSIS
.B phpunit
[\fI\,options\/\fR] \fI\,UnitTest.php\/\fR
.br
.B phpunit
[\fI\,options\/\fR] \fI\,<directory>\/\fR
.SH DESCRIPTION
Code Coverage Options:
.TP
\fB\-\-coverage\-clover\fR <file>
Generate code coverage report in Clover XML format
.HP
\fB\-\-coverage\-cobertura\fR <file> Generate code coverage report in Cobertura XML format
.TP
\fB\-\-coverage\-crap4j\fR <file>
Generate code coverage report in Crap4J XML format
.TP
\fB\-\-coverage\-html\fR <dir>
Generate code coverage report in HTML format
.TP
\fB\-\-coverage\-php\fR <file>
Export PHP_CodeCoverage object to file
.TP
\fB\-\-coverage\-text=\fR<file>
Generate code coverage report in text format [default: standard output]
.TP
\fB\-\-coverage\-xml\fR <dir>
Generate code coverage report in PHPUnit XML format
.TP
\fB\-\-coverage\-cache\fR <dir>
Cache static analysis results
.TP
\fB\-\-warm\-coverage\-cache\fR
Warm static analysis cache
.TP
\fB\-\-coverage\-filter\fR <dir>
Include <dir> in code coverage analysis
.TP
\fB\-\-path\-coverage\fR
Perform path coverage analysis
.TP
\fB\-\-disable\-coverage\-ignore\fR
Disable annotations for ignoring code coverage
.TP
\fB\-\-no\-coverage\fR
Ignore code coverage configuration
.PP
Logging Options:
.TP
\fB\-\-log\-junit\fR <file>
Log test execution in JUnit XML format to file
.TP
\fB\-\-log\-teamcity\fR <file>
Log test execution in TeamCity format to file
.TP
\fB\-\-testdox\-html\fR <file>
Write agile documentation in HTML format to file
.TP
\fB\-\-testdox\-text\fR <file>
Write agile documentation in Text format to file
.TP
\fB\-\-testdox\-xml\fR <file>
Write agile documentation in XML format to file
.TP
\fB\-\-reverse\-list\fR
Print defects in reverse order
.TP
\fB\-\-no\-logging\fR
Ignore logging configuration
.PP
Test Selection Options:
.TP
\fB\-\-list\-suites\fR
List available test suites
.TP
\fB\-\-testsuite\fR <name>
Filter which testsuite to run
.TP
\fB\-\-list\-groups\fR
List available test groups
.TP
\fB\-\-group\fR <name>
Only runs 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 runs tests annotated with "@covers <name>"
.TP
\fB\-\-uses\fR <name>
Only runs tests annotated with "@uses <name>"
.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\-\-test\-suffix\fR <suffixes>
Only search for test in files with specified suffix(es). Default: Test.php,.phpt
.PP
Test Execution Options:
.HP
\fB\-\-dont\-report\-useless\-tests\fR Do not report tests that do not test anything
.TP
\fB\-\-strict\-coverage\fR
Be strict about @covers annotation usage
.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\-\-disallow\-resource\-usage\fR
Be strict about resource usage during small 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 without @small, @medium or @large
.TP
\fB\-\-disallow\-todo\-tests\fR
Disallow @todo\-annotated tests
.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 attributes for each test
.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\-\-stop\-on\-defect\fR
Stop execution upon first not\-passed test
.TP
\fB\-\-stop\-on\-error\fR
Stop execution upon first error
.TP
\fB\-\-stop\-on\-failure\fR
Stop execution upon first error or failure
.TP
\fB\-\-stop\-on\-warning\fR
Stop execution upon first warning
.TP
\fB\-\-stop\-on\-risky\fR
Stop execution upon first risky test
.TP
\fB\-\-stop\-on\-skipped\fR
Stop execution upon first skipped test
.TP
\fB\-\-stop\-on\-incomplete\fR
Stop execution upon first incomplete test
.TP
\fB\-\-fail\-on\-incomplete\fR
Treat incomplete tests as failures
.TP
\fB\-\-fail\-on\-risky\fR
Treat risky tests as failures
.TP
\fB\-\-fail\-on\-skipped\fR
Treat skipped tests as failures
.TP
\fB\-\-fail\-on\-warning\fR
Treat tests with warnings as failures
.TP
\fB\-v\fR|\-\-verbose
Output more verbose information
.TP
\fB\-\-debug\fR
Display debugging information
.TP
\fB\-\-repeat\fR <times>
Runs the test(s) repeatedly
.TP
\fB\-\-teamcity\fR
Report test execution progress in TeamCity format
.TP
\fB\-\-testdox\fR
Report test execution progress in TestDox format
.TP
\fB\-\-testdox\-group\fR
Only include tests from the specified group(s)
.TP
\fB\-\-testdox\-exclude\-group\fR
Exclude tests from the specified group(s)
.TP
\fB\-\-no\-interaction\fR
Disable TestDox progress animation
.TP
\fB\-\-printer\fR <printer>
TestListener implementation to use
.TP
\fB\-\-order\-by\fR <order>
Run tests in order: default|defects|duration|no\-depends|random|reverse|size
.TP
\fB\-\-random\-order\-seed\fR <N>
Use a specific random seed <N> for random order
.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
.PP
Configuration Options:
.TP
\fB\-\-prepend\fR <file>
A PHP script that is included as early as possible
.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\-\-extensions\fR <extensions>
A comma separated list of PHPUnit extensions to load
.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\-result\-file\fR <file>
Specify result cache path and filename
.TP
\fB\-\-generate\-configuration\fR
Generate configuration file with suggested settings
.TP
\fB\-\-migrate\-configuration\fR
Migrate configuration file to current format
.PP
Miscellaneous Options:
.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