Stars: 983
Forks: 98
Pull Requests: 723
Issues: 285
Watchers: 23
Last Updated: 2023-08-03 10:49:32
📦🚀 Fast, zero config application bundler with PHARs.
License: MIT License
Languages: PHP, Batchfile, Makefile, Shell, Smarty, Dockerfile
Upgrading from Box2? Checkout the upgrade guide!
The Box application simplifies the PHAR building process. Out of the box (no pun intended), the application can do many great things:
box info
or box diff
)box verify
)box validate
)box docker
)For the full documentation see https://box-project.github.io/box.
base-path
)main
)output
)chmod
)check-requirements
)dump-autoload
)compactors
)
compression
)metadata
)replacements
)replacement-sigil
)datetime
)datetime-format
)git
)git-commit
)git-commit-short
)git-tag
)git-version
)Creating a PHAR should be as simple as running box compile
(no config required!). It will however assume some
defaults that you might want to change. Box will by default be looking in order for the files box.json
and
box.json.dist
in the current working directory. A basic configuration could be for example changing the PHAR
permissions:
{
"chmod": "0700"
}
You can then find more advanced configuration settings in [the configuration documentation][configuration]. For more information on which command or options is available, you can run:
box help
The project provides a Makefile
in which the most common commands have been registered such as fixing the coding
style or running the test.
make
The policy is for the major part following the same as Symfony's one. Note that the code marked
as @private
or @internal
are excluded from the BCP.
The text displayed by the commands (e.g. compile
or info
) or the content of the error/exception messages are also not subject to the BCP.
Project originally created by: Kevin Herrera (@kherge) which has now been moved under the Humbug umbrella.