Installation

Perform is designed to be added to Symfony applications with the composer package manager.

Pick the bundles you need for your application, then require them in your project’s composer.json.

For example, to add the base bundle:

composer require perform/base-bundle

Note

If you use Symfony flex, the bundles will be configured automatically. If not, be sure to add them to your project’s Kernel.

See the bundle guides for detailed instructions.

Install the cli tool

A command-line tool is available with some time-saving features.

composer global require perform/cli dev-master

Make sure the composer bin directory is on your $PATH. For example, if using bash, you could add the following to your .bashrc:

PATH+=:~/.composer/vendor/bin

Then run perform to check the cli is installed.

The cli has many commands, such as:

  • perform new <directory> will create a new Symfony application pre-configured with the Perform bundles of your choice.
  • perform requirements will check your system can run Perform effectively.

View the cli documentation for a detailed guide.