Installation

#

We provide multiple installation methods depending on your local development environment. Simply pick the option that works best for you.

Laravel Herd

#

If you are using Laravel Herd, Cloakr is already available in your terminal and you are ready to go. Simply set up your token and share your first site.

PHP Archive (PHAR)

#

We distribute Cloakr as a PHAR archive that contains everything you need in order to use Cloakr. Simply download it from here and make it executable. This method only works if you have a modern version of PHP installed.

curl https://github.com/cloakrdev/cloakr/raw/master/builds/cloakr -L --output Cloakr

chmod +x Cloakr

./cloakr

You most likely want to put the Cloakr.phar into a directory on your PATH, so you can simply call Cloakr from any directory. For example:

sudo mv cloakr.phar /usr/local/bin/cloakr

After that, you are ready to go and can share your first site.

Via Composer

#

Cloakr is a PHP application and you can install the client for your local machine as a global composer dependency:

composer global require cloakrdev/cloakr

Make sure that your global composer directory is inside of your PATH environment variable. Simply add this directory to your PATH in your ~/.bash_profile (or ~/.bashrc) like this:

export PATH=~/.composer/vendor/bin:$PATH

Extending Cloakr

#

By default, Cloakr comes as an executable PHAR file. This allows you to use all Cloakr features out of the box – without any additional setup required.

If you want to modify Cloakr and want to add custom request or response modifiers, you can learn more about customization options in the documentation for Request Plugins.

Updating the Cloakr client

#

You can update the Cloakr client to the latest version by running the self-update command.

Cloakr self-update