CLI Options
Overview
The Pest command line runner has many available options that can make your testing experience easier.
Available Options
Pest defers non-Pest-specific options to PHPUnit, so please refer to the PHPUnit command-line test runner documentation for a full list.
--init
This option allows you to initialize a standard Pest configuration, with the following files:
- A
tests
directory. - A
phpunit.xml
file that contains the PHPUnit configuration file. - A
tests/Pest.php
file that contains the Pest configuration file. - A
tests/ExampleTest.php
file, with a default example test.
--coverage
This option enables coverage using the underlying --coverage-php
option, and will output the results to the terminals standard output.
You can combine this with other coverage options from PHPUnit such as --coverage-xml
or --coverage-html
.
--min
This option allows you to set a minimum required coverage value. If the coverage does not meet this value, the test suite will fail.
--group
This option allows you to only run a specific list of grouped tests. This is a comma-separated list.
--exclude-group
You may also use the --exclude-group
option to instruct Pest to exclude grouped tests. This is a comma-separated list.
--test-directory
This option allows you to specify the directory that will be used to gather the tests that should be run. If it isn't provided the default tests
directory will be used.
--ci
You may use the --ci
option to instruct Pest that the test suite is running within a Continuous Integration environment. When provided, this option makes Pest ignore development/local features such as ->only().
Next section: Laravel Plugin →