2025-03-14 21:59:59 -06:00
|
|
|
# phan
|
|
|
|
|
|
|
|
|
|
> A static analysis tool for PHP.
|
|
|
|
|
> More information: <https://github.com/phan/phan>.
|
|
|
|
|
|
|
|
|
|
- Generate a `.phan/config.php` in the current directory:
|
|
|
|
|
|
|
|
|
|
`phan --init`
|
|
|
|
|
|
|
|
|
|
- Generate a Phan configuration file using a specific level (1 being strictest to 5 being the least strict):
|
|
|
|
|
|
|
|
|
|
`phan --init --init-level {{level}}`
|
|
|
|
|
|
|
|
|
|
- Analyze the current directory:
|
|
|
|
|
|
|
|
|
|
`phan`
|
|
|
|
|
|
|
|
|
|
- Analyze one or more directories:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`phan {{--directory path/to/directory1 --directory path/to/directory2 ...}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Specify a configuration file (defaults to `.phan/config.php`):
|
|
|
|
|
|
|
|
|
|
`phan --config-file {{path/to/config.php}}`
|
|
|
|
|
|
|
|
|
|
- Specify the output mode:
|
|
|
|
|
|
|
|
|
|
`phan --output-mode {{text|verbose|json|csv|codeclimate|checkstyle|pylint|html}}`
|
|
|
|
|
|
|
|
|
|
- Specify the number of parallel processes:
|
|
|
|
|
|
|
|
|
|
`phan --processes {{number_of_processes}}`
|
