Download the PHP package humbug/box without Composer
On this page you can find all versions of the php package humbug/box. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package box
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 info
orbox 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
)
For the full documentation see https://box-project.github.io/box.
Table of Contents
- Installation
- Phive
- Composer
- Homebrew
- GitHub
- Docker
- shivammathur/setup-php (GitHub Actions)
- Usage
- Configuration
- Base path (
base-path
) - Main (
main
) - Output (
output
) - Permissions (
chmod
) - Check requirements (
check-requirements
) - Including files
- Force auto-discovery (
force-autodiscovery
) - Files (
files
andfiles-bin
) - Directories (
directories
anddirectories-bin
) - Finder (
finder
andfinder-bin
) - Blacklist (
blacklist
) - Excluding the Composer files (
exclude-composer-files
) - Excluding dev files (
exclude-dev-files
) - Map (
map
)
- Force auto-discovery (
- Stub
- Stub (
stub
) - Alias (
alias
) - Shebang (
shebang
) - Banner (
banner
) - Banner file (
banner-file
)
- Stub (
- Forcing the timestamp (
timestamp
) - Dumping the Composer autoloader (
dump-autoload
) - Compactors (
compactors
)- Annotations (
annotations
) - PHP-Scoper (
php-scoper
)
- Annotations (
- Compression algorithm (
compression
) - Security
- Signing algorithm (
algorithm
) - The private key (
key
) - The private key password (
key-pass
)
- Signing algorithm (
- 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
- Configuration
- PHP version requirements
- Extension configuration requirements
- Polyfills
- Integration with a custom stub
- Configuration
- Optimize your PHAR
- Review your files
- Compress your PHAR
- Optimize your code
- PHAR code isolation
- Why/Explanation
- Isolating the PHAR
- Debugging the scoping
- Docker support
- Symfony support
- Project files
- Project directory
- Cache
- Reproducible builds
- Creating a reproducible PHAR
- PHP-Scoper
- Composer
- Composer root version
- Composer autoload suffix
- Box
- PHAR alias
- Requirement Checker
- Box banner
- PHAR
- Usages
- Creating a reproducible PHAR
- PHAR signing best practices
- Built-in PHAR API
- How to sign your PHAR
- How it works
- Why it is bad
- How to (properly) sign your PHAR
- Create a new GPG-key
- Manually signing
- Generate the encryption key
- Secure your encryption key
- Sign your PHAR
- Verifying the PHAR signature
- Automatically sign in GitHub Actions
- Built-in PHAR API
- FAQ
- What is the canonical way to write a CLI entry file?
- The shebang
- The PHP_SAPI check
- Autoloading Composer
- Detecting that you are inside a PHAR
- Building a PHAR with Box as a dependency
- What is the canonical way to write a CLI entry file?
- 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:
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:
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.
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.
All versions of box with dependencies
ext-iconv Version *
ext-mbstring Version *
ext-phar Version *
composer-plugin-api Version ^2.2
amphp/parallel Version ^2.0
composer/semver Version ^3.3.2
composer/xdebug-handler Version ^3.0.3
fidry/console Version ^0.6.0
fidry/filesystem Version ^1.2.1
humbug/php-scoper Version ^0.18.6
justinrainbow/json-schema Version ^5.2.12
nikic/iter Version ^2.2
phpdocumentor/reflection-docblock Version ^5.4
phpdocumentor/type-resolver Version ^1.7
psr/log Version ^3.0
sebastian/diff Version ^5.0
seld/jsonlint Version ^1.10.2
seld/phar-utils Version ^1.2
symfony/finder Version ^6.4.0 || ^7.0.0
symfony/polyfill-iconv Version ^1.28
symfony/polyfill-mbstring Version ^1.28
symfony/process Version ^6.4.0 || ^7.0.0
symfony/var-dumper Version ^6.4.0 || ^7.0.0
thecodingmachine/safe Version ^2.5
webmozart/assert Version ^1.11