README

This is a REPL plugin for CakePHP 4. It provides an interactive command prompt that lets you interact with and inspect objects in your application.

It also provides several global functions to make debugging and interactive sessions simpler.

Installation

You can install this plugin into your CakePHP application using Composer.

Run the following command

composer require --dev cakephp/repl

Configuration

Load the plugin by adding the following statement to Application::bootstrapCli() method in the src/Application.php file of your application:

if (Configure::read('debug')) {
    $this->addPlugin('Cake/Repl');
}

Make sure to use either "debug mode" check to load it, or wrap it in a try/catch block. Otherwise it will also try to load in production, where the require-dev plugins are not available and shouldn't be.

Documentation

Full documentation of the plugin can be found on the CakePHP Cookbook.