Fork of the unmaintained box2 project. This project needs your help!
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:
- ⚡ 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 info) - 🕵️♀️ Verify the signature of an existing PHAR (
box verify) - 📝 Use Git tags and short commit hashes for versioning
- Installation
- Usage
- Configuration
- Requirements checker
- Optimize your PHAR
- PHAR code isolation
- Contributing
- Upgrade guide
- Backward Compatibility Promise (BCP)
- Credits
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": "0755"
}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
The project provides a Makefile in which the most common commands have been registered such as fixing the coding
style or running the test.
makeThe policy is for the major part following the same as [Symfony's one][symfony-bc-policy]. Note that the code marked
as @private or @internal are excluded from the BCP.
Project originally created by: Kevin Herrera (@kherge) which has now been moved under the Humbug umbrella.