Helps to discover and install tools.
Toolbox started its life as a simple script in the phpqa docker image. Its purpose was to install set of tools while building the docker image and it's still its main goal. It has been extracted as a separate project to make maintenance easier and enable new use cases.
| Name | Summary |
|---|---|
| analyze | Visualizes metrics and source code |
| box-legacy | Legacy version of box |
| composer-normalize | Composer plugin to normalize composer.json files |
| design-pattern | Detects design patterns |
| parallel-lint | Checks PHP file syntax |
| php-formatter | Custom coding standards fixer |
| phpcf | Finds usage of deprecated features |
| phpdoc-to-typehint | Automatically adds type hints and return types based on PHPDocs |
| phpstan-localheinz-rules | Additional rules for PHPstan |
| phpunit-5 | The PHP testing framework (5.x version) |
| phpunit-7 | The PHP testing framework (7.x version) |
| security-checker | Checks composer dependencies for known security vulnerabilities |
| testability | Analyses and reports testability issues of a php codebase |
Get the toolbox.phar from the latest release.
The command below should do the job:
curl -Ls https://github.com/jakzal/toolbox/releases/latest/download/toolbox.phar -o toolbox && chmod +x toolbox./toolbox list-tools
To exclude some tools from the listing multiple --exclude-tag options can be added.
The --tag option can be used to filter tools by tags.
./toolbox list-tools --exclude-tag exclude-php:8.2 --exclude-tag foo --tag bar
./toolbox install
By default tools are installed in the /usr/local/bin directory. To perform an installation in another location,
pass the --target-dir option to the install command. Also, to change the location composer packages are installed in,
export the COMPOSER_HOME environment variable.
mkdir /tools
export COMPOSER_HOME=/tools/.composer
export PATH="/tools:$COMPOSER_HOME/vendor/bin:$PATH"
./toolbox install --target-dir /tools
The target dir can also be configured with the TOOLBOX_TARGET_DIR environment variable.
To only see what commands would be executed, use the dry run mode:
./toolbox install --dry-run
To exclude some tools from the installation multiple --exclude-tag options can be added.
The --tag option can be used to filter tools by tags.
./toolbox install --exclude-tag exclude-php:8.2 --exclude-tag foo --tag bar
./toolbox test
To only see what commands would be executed, use the dry run mode:
./toolbox test --dry-run
To exclude some tools from the generated test command multiple --exclude-tag options can be added.
The --tag option can be used to filter tools by tags.
./toolbox test --exclude-tag exclude-php:8.2 --exclude-tag foo --tag bar
By default the following files are used to load tool definitions:
resources/pre-installation.jsonresources/architecture.jsonresources/checkstyle.jsonresources/compatibility.jsonresources/composer.jsonresources/deprecation.jsonresources/documentation.jsonresources/linting.jsonresources/metrics.jsonresources/phpstan.jsonresources/psalm.jsonresources/refactoring.jsonresources/security.jsonresources/test.jsonresources/tools.json
Definitions can be loaded from customised files by passing the --tools option(s):
./toolbox list-tools --tools path/to/file1.json --tools path/to/file2.json
Tool definition location(s) can be also specified with the TOOLBOX_JSON environment variable:
TOOLBOX_JSON='path/to/file1.json,path/to/file2.json' ./toolbox list-tools
Tools can be tagged in order to enable grouping and filtering them.
The tags below have a special meaning:
pre-installation- these tools will be installed before any other tools.exclude-php:8.1,exclude-php:8.2etc - used to exclude installation on the specified php version.
Please read the Contributing guide to learn about contributing to this project. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.