Fork of the unmaintained box2 project. This project needs your help!
Upgrading from Box2? Checkout the upgrade guide!
Goal
The Box application simplifies the PHAR building process. Out of the box (no pun intended), the application can do many
great things:
- ⚡ Fast application bundling
- ? PHAR isolation
- ⚙️ Zero configuration by default
- ? Requirements checker
- ? Friendly error logging experience
- ? Retrieve information about the PHAR extension or a PHAR file and its contents (
box infoorbox diff) - ?️ Verify the signature of an existing PHAR (
box verify) - ? Use Git tags and short commit hashes for versioning
- ?️️ Get recommendations and warnings about regarding your configuration (
box validate) - ? Docker support (
box docker)
Table of Contents
- Installation
- Usage
- Configuration
- Base path (
base-path) - Main (
main) - Output (
output) - Permissions (
chmod) - Check requirements (
check-requirements) - Including files
- Stub
- Dumping the Composer autoloader (
dump-autoload) - Compactors (
compactors) - Compression algorithm (
compression) - Security
- Metadata (
metadata) - Replaceable placeholders
- Replacements (
replacements) - Replacement sigil (
replacement-sigil) - Datetime placeholder (
datetime) - Datetime placeholder format (
datetime-format) - Pretty git commit placeholder (
git) - Git commit placeholder (
git-commit) - Short git commit placeholder (
git-commit-short) - Git tag placeholder (
git-tag) - Git version placeholder (
git-version)
- Replacements (
- Base path (
- Requirements checker
- Optimize your PHAR
- PHAR code isolation
- Docker support
- Symfony support
- Contributing
- Upgrade guide
- Backward Compatibility Promise (BCP)
- Credits
Usage
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.
For more information on which command or options is available, you can run:
box help
Contributing
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
Backward Compatibility Promise (BCP)
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.
Credits
Project originally created by: Kevin Herrera (@kherge) which has now been moved under the Humbug umbrella.