English | 中文
Box is committed to helping improve the programming experience of PHP applications, expecially for Hyperf, managing the PHP environment and related dependencies, providing the ability to package PHP applications as binary programs, and also providing reverse proxy services for managing and deploying Swoole/Swow applications.
wget https://github.com/hyperf/box/releases/download/v0.5.4/box_x86_64_macos -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
// Make sure /usr/local/bin/box in your $PATH env, or put `box` into any path in $PATH env that you want
wget https://github.com/hyperf/box/releases/download/v0.5.4/box_x86_64_linux -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
// Make sure /usr/local/bin/box in your $PATH env, or put `box` into any path in $PATH env that you want
At present, we are short of AARCH64 Github Actions Runner, so we cannot timely construct the bin file of AARCH64 version.
wget https://github.com/hyperf/box/releases/download/v0.0.3/box_php8.1_aarch64_linux -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
// Make sure /usr/local/bin/box in your $PATH env, or put `box` into any path in $PATH env that you want
curl -o box.exe https://github.com/hyperf/box/releases/download/v0.5.4/box_x64_windows.exe
// Put `box.exe` into any path in $PATH env that you want, and use `box.exe` instead of `box` when executing on Windows
Box needs a Github Access Token to request github api, to retrieve the versions of the package.
workflow
scope have to be selected.box config set github.access-token <Your Token>
to init the token.By default, Box is supported by Swow Kernel, but we also provide Swoole Kernel, you can switch to Swoole Kernel by box config set kernel swoole
, but it should be noted that Swoole Kernel only supports PHP 8.1 version, and The Build Binaries feature and Windows Systems are not supported.
// set to Swow Kernel [default]
box config set kernel swow
// set to Swoole Kernel (NOT supported on Windows)
box config set kernel swoole
box get pkg@version
to install the package from remote automatically, pkg
is the package name, and version
is the version of package, box get pkg
means to install the latest version of pkg, for example, run box get php@8.1
to install the PHP 8.1, run box get composer
to install the latest composer binbox build-prepare
to get ready for build
and build-self
commandbox build-self
to build the box
bin itselfbox build <path>
to build a Hyperf application into a binary filebox self-update
to update the box
bin to latest versionbox config list
to dump the config filebox config get <key>
to retrieve the value by key from config filebox config set <key> <value>
to set value by key into the config filebox config unset <key>
to unset the config value by keybox config set-php-version <version>
to set the current PHP version of box, available value: 8.0 | 8.1box config get-php-version <version>
to get the current PHP version of boxbox reverse-proxy -u <upsteamHost:upstreamPort>
to start a reverse proxy HTTP server for the upstream serversbox php <argument>
to run any PHP command via current PHP version of boxbox composer <argument>
to run any Composer command via box, the version of the composer bin depends on the last executed get composer
commandbox php-cs-fixer <argument>
to run any php-cs-fixer
command via box, the version of the composer bin depends on the last executed get php-cs-fixer
commandbox cs-fix <argument>
to run php-cs-fix fix
command via box, the version of the composer bin depends on the last executed get php-cs-fixer
commandbox phpstan <argument>
to run any phpstan
command via box, the version of the composer bin depends on the last executed get phpstan
command, since box v0.3.0box pint <argument>
to run any pint
command via box, the version of the composer bin depends on the last executed get pint
command, since box v0.3.0box version
to dump the current version of the box binIf you want to experience the full features of Box, you need to run it based on the Swow Kernel, so you need to base your project on hyperf/swow-skeleton to run your project, you can create a Swow skeleton project based on Hyperf 3.0 RC version by box composer create-project hyperf/swow-skeleton:dev-master
command.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。