Skip to content

installation.md

Latest commit

 

History

History
127 lines (86 loc) · 3.09 KB

installation.md

File metadata and controls

127 lines (86 loc) · 3.09 KB

Installation

  1. Phive
  2. Composer
  3. Homebrew
  4. GitHub
  5. Docker
  6. shivammathur/setup-php (GitHub Actions)

Phive

You can install Box with Phive

phive install humbug/box

To upgrade box use the following command:

phive update humbug/box

Composer

You can install Box with Composer:

composer global require humbug/box

If you cannot install it because of a dependency conflict or you prefer to install it for your project, we recommend you to take a look at bamarni/composer-bin-plugin. Example:

composer require --dev bamarni/composer-bin-plugin
composer bin box require --dev humbug/box

vendor/bin/box

Homebrew

To install box using Homebrew, you need to tap the box formula first

brew tap box-project/box
brew install box

The box command is now available to run from anywhere in the system:

box -v

To upgrade box use the following command:

brew upgrade box

GitHub

You may download the Box PHAR directly from the GitHub release directly. You should however beware that it is not as secure as downloading it from the other mediums. Hence, it is recommended to check the signature when doing so:

# Do adjust the URL if you need a release other than the latest
wget -O box.phar "https://github.com/box-project/box/releases/latest/download/box.phar"
wget -O box.phar.asc "https://github.com/box-project/box/releases/latest/download/box.phar.asc"

# Check that the signature matches
gpg --verify box.phar.asc box.phar

# Check the issuer (the ID can also be found from the previous command)
gpg --keyserver hkps://keys.openpgp.org --recv-keys 41539BBD4020945DB378F98B2DF45277AEF09A2F

rm box.phar.asc
chmod +x box.phar

Docker

The official docker image for the project is boxproject/box:

docker pull boxproject/box
docker run --rm -v $(pwd):/app boxproject/box

Beware that with the above you may be limited with the Composer binary used. If you need your own Composer binary, you will have to create a docker file to add it to the same volume with the right permissions.

Box automatically looks up for a Composer binary and the docker image ships one, if you want to use your own you may also need to specify it with --composer-bin.

shivammathur/setup-php (GitHub Actions)

Box is supported as a shivammathur/setup-php tool:

- name: Setup PHP with tools
  uses: shivammathur/setup-php@v2
  with:
      php-version: '8.3'
      tools: box

« Table of Contents • Usage »
⚡