Skip to content

First Run & CLI Options

Running the Analysis

To run the architecture tests, execute the following command:

shell
php bin/structura analyze

CLI Options

OptionDescription
-c, --config[=CONFIG]Path to config file.
--filter[=FILTER]Filter which tests to run using pattern matching on the test name (class or method).
--testsuite[=TESTSUITE]List available test suites as defined in the PHP configuration file.
-f, --error-format[=ERROR-FORMAT]Error output format (see below).
-p, --progress-format[=PROGRESS-FORMAT]Progress output format (see below).
--stop-on-errorStop execution upon first error.
--stop-on-warningStop execution after the first warning.
--stop-on-noticeStop execution after the first notice.

Error Formats

FormatDescription
textDefault. For human consumption.
githubCreates GitHub Actions compatible output.

Progress Formats

FormatDescription
textDefault. For human consumption.
barProgress bar display.

Released under the MIT License.