Command Line Usage
PHPStan’s executable file is installed in Composer’s bin-dir which defaults to vendor/bin.
Analysing code #
To analyse your code, run the analyse command. Exit code 0 means there are no errors.
vendor/bin/phpstan analyse [options] [<paths>...]As <paths> you can pass one or multiple paths to PHP files or directories separated by spaces. When looking for files in directories, various configuration options are respected. Relative paths are resolved based on the current working directory.
--level|-l #
Specifies the rule level to run.
--configuration|-c #
Specifies the path to a configuration file. Relative paths are resolved based on the current working directory.
--generate-baseline|-b #
Generates the baseline to a file. Accepts a path (--generate-baseline foo.neon) which defaults to phpstan-baseline.neon. Relative paths are resolved based on the current working directory.
If you already use the baseline, the path to the baseline file should match the one already in use. This guarantees that the baseline isn’t double-used and that the command functions correctly.
Please note that the exit code differs in this case. Exit code 0 means that the baseline generation was successful and the baseline is not empty. If there are no errors that the baseline would consist of, the exit code is 1.
By default PHPStan will not generate an empty baseline. However you can pass --allow-empty-baseline alongside --generate-baseline to allow an empty baseline file to be generated.
--pro #
Launches PHPStan Pro which lets you browse errors (including ignored errors) in a beautiful web UI. Try it out by running PHPStan with --pro or by going to account.phpstan.com and creating an account.
--autoload-file|-a #
If your application uses a custom autoloader, you should set it up and register in a PHP file that is passed to this CLI option. Relative paths are resolved based on the current working directory.
--error-format #
Specifies a custom error formatter. Learn more about output formats »
--no-progress #
Turns off the progress bar. Does not accept any value.
--memory-limit #
Specifies the memory limit in the same format php.ini accepts.
Example: --memory-limit 1G
--xdebug #
PHPStan turns off Xdebug if it’s enabled to achieve better performance.
If you need to debug PHPStan itself or your custom extensions and want to run PHPStan with Xdebug enabled, pass this option. It does not accept any value.
--debug #
Instead of the progress bar, it outputs lines with each analysed file before its analysis.
Additionally, it stops on the first internal error and prints a stack trace.
This option also disables the result cache and parallel processing for debugging purposes.
-v, -vv, -vvv #
Increases the verbosity and makes PHPStan show various debugging information like consumed memory or why result cache is not used.
Combining -vvv with --debug is great for identifying slow files.
Running with -vvv will also print same information as the diagnose command.
--ansi, --no-ansi #
Overrides the autodetection of whether colors should be used in the output and how nice the progress bar should be.
--quiet|-q #
Silences all the output. Useful if you’re interested only in the exit code.
--version|-V #
Instead of running the analysis, it just outputs the current PHPStan version in use.
--help #
Outputs a summary of available CLI options, but not as in much detail as this page.
Running without arguments #
You can analyse your project just by running vendor/bin/phpstan if you satisfy the following conditions:
- You have
phpstan.neonorphpstan.neon.distin your current working directory - This file contains the
pathsparameter to set a list of analysed paths - This file contains the
levelparameter to set the current rule level
Clearing the result cache #
To clear the current state of the result cache, for example if you’re developing custom extensions and the result cache is getting stale too often.
vendor/bin/phpstan clear-result-cache [options]The clear-result-cache command shares some of the options with the analyse command. The reason is that the configuration file might be setting a custom tmpDir which is where the result cache is saved.
--configuration|-c #
Specifies the path to a configuration file. Relative paths are resolved based on the current working directory.
--autoload-file|-a #
If your application uses a custom autoloader, you should set it up and register in a PHP file that is passed to this CLI option. Relative paths are resolved based on the current working directory.
--memory-limit #
Specifies the memory limit in the same format php.ini accepts.
Example: --memory-limit 1G
--debug #
If the clear-result-cache command is failing with an uncaught exception, run it again with --debug to see the stack trace.
--quiet|-q #
Silences all the output. Useful if you’re interested only in the exit code.
--version|-V #
Instead of clearing the result cache, it just outputs the current PHPStan version in use.
--help #
Outputs a summary of available CLI options, but not as in much detail as this page.
Diagnose problems #
To diagnose why PHPStan is behaving a certain way, you can run the diagnose command:
vendor/bin/phpstan diagnose [options]It outputs useful information like current PHP runtime version, current PHP version for analysis (which might be different based on configuration), current PHPStan version etc. Custom extensions can also implement DiagnoseExtension interface to add their own information that also gets printed when running the diagnose command.
The same information is also printed when you run analyse command with -vvv.
--configuration|-c #
Specifies the path to a configuration file. Relative paths are resolved based on the current working directory.
--autoload-file|-a #
If your application uses a custom autoloader, you should set it up and register in a PHP file that is passed to this CLI option. Relative paths are resolved based on the current working directory.
--level|-l #
Specifies the rule level to run.
--memory-limit #
Specifies the memory limit in the same format php.ini accepts.
Example: --memory-limit 1G
--debug #
Thrown exceptions (internal errors) will not be caught and their stack trace will be printed in full when this option is added.