/composer-license-checker

Quickly scan your dependencies, see what licenses they use, or validate in your CI pipeline that no unwanted licenses were merged.

Primary LanguagePHPMIT LicenseMIT

Composer License Checker

Latest Version on Packagist Build Status Quality Score Scrutinizer coverage Total Downloads

Quickly scan your dependencies, see what licenses they use or check in your CI that no unwanted licenses were merged.

The lookup of the summaries for every license done on https://tldrlegal.com/.
Please inform yourself in more detail about the licenses you use and do not use the provided summary as your sole information.

Installation

You can install the package via composer:

composer require dominikb/composer-license-checker

Usage

Two separate commands are provided:

  • ./composer-license-checker check
  • ./composer-license-checker report

Use ./composer-license-checker help to get info about general usage or use the syntax ./composer-license-checker help COMMAND_NAME to see more information about a specific command available.

vendor/bin/composer-license-checker check --allowlist MIT

vendor/bin/composer-license-checker report -p /path/to/your/project -c /path/to/composer.phar

Testing

composer test

Code coverage reports are output to the build folder. See .phpunit.xml.dist for more testing configuration.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email bauernfeind.dominik@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.