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