# PhpMetrics


![Packagist Downloads](https://img.shields.io/packagist/dt/phpmetrics/phpmetrics)
[![License](https://poser.pugx.org/phpmetrics/phpmetrics/license.svg)](https://packagist.org/packages/phpmetrics/phpmetrics)
[![Latest Stable Version](https://poser.pugx.org/phpmetrics/phpmetrics/v/stable.svg)](https://packagist.org/packages/phpmetrics/phpmetrics)
<a href="https://github.com/sponsors/Halleck45"><img src="https://img.shields.io/static/v1?label=Sponsor&amp;message=%E2%9D%A4&amp;logo=GitHub&amp;color=%23fe8e86" alt=""></a>


![Standard report](./doc/overview.png)

<img src="https://raw.githubusercontent.com/phpmetrics/PhpMetrics/master/doc/phpmetrics-logo.png" height="80px" alt="PhpMetrics" align="left" style="margin-right:20px"/>

PhpMetrics provides metrics about PHP project and classes, with beautiful and readable HTML report. 

[Documentation](https://phpmetrics.github.io/website/) | [Twitter](https://twitter.com/Halleck45) | [Contributing](https://github.com/phpmetrics/PhpMetrics/blob/master/doc/contributing.md)

<br/><br/>


## Quick start

Follow the [quick start guide](https://phpmetrics.github.io/website/getting-started/) to get started.
```bash
# install the package as a dev dependency
composer require phpmetrics/phpmetrics --dev

# run PHPMetrics to analyze a folder and generate a report
php ./vendor/bin/phpmetrics --report-html=myreport <folder-to-analyze>
```

Then open the generated `./myreport/index.html` file in your browser. 

> You can use a [configuration file](https://phpmetrics.github.io/website/configuration/) to customize 
> the report, add options, configure rules for Continuous Integration, etc.

## Metrics

You'll find detailed list of metrics in [documentation](https://phpmetrics.github.io/website/metrics/), or 
running `php ./vendor/bin/phpmetrics --metrics`

## Author

+ Jean-François Lépine <[@Halleck45](https://twitter.com/Halleck45)>

## License

See the [LICENSE](LICENSE) file.

## Contributing

See the [CONTRIBUTING](doc/contributing.md) file.

## Support the project

PHPMetrics is built and maintained on free time. If it saved you some of yours:

- ⭐ **Star the repository**. It costs nothing and it is how most developers discover the tool.
- ❤️ **[Become a sponsor](https://github.com/sponsors/Halleck45)**. Sponsorship directly funds maintenance time and the addition of new features and metrics.