Getting Started

Box Manifest is a powerful PHAR framework on top of BOX project, that simplifies the PHAR building process.

If you're familiar with PHP, you can install Box Manifest with composer, the PHP package manager. If not, we recommend using docker.

Requirements

• PHP 8.2 or greater
• ext-phar
• PHPUnit 11 or greater (if you want to run unit tests)

Installation

with composer recommended

Latest4.x

composer require bartlett/box-manifest

composer require bartlett/box-manifest ^4.1

Tip

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-manifest require --dev bartlett/box-manifest

with docker

Latest4.x

docker pull ghcr.io/llaville/box-manifest

docker pull ghcr.io/llaville/box-manifest:v4

with phive

PHIVE : The Phar Installation and Verification Environment

GloballyLocally

Install

phive install llaville/box-manifest --force-accept-unsigned

or update previous installation

phive update llaville/box-manifest --force-accept-unsigned

To your project, with an XML configuration file :

.phive/phars.xmlCommand(s)

<?xml version="1.0" encoding="UTF-8"?>
<phive xmlns="https://phar.io/phive">
    <phar name="llaville/box-manifest" version="^4.1" copy="false" />
</phive>

phive install --force-accept-unsigned

or

phive update --force-accept-unsigned

with git

Box Manifest can be directly used from GitHub by cloning the repository into a subfolder of your project root which might be useful if you want to use the very latest version.

Master4.x

git clone https://github.com/llaville/box-manifest.git

git clone -b 4.x https://github.com/llaville/box-manifest.git

Next, install the dependencies

composer update