https://github.com/cakephp/repl

Console tools for a REPL interface for CakePHP applications
https://github.com/cakephp/repl

Last synced: 7 months ago
JSON representation

Console tools for a REPL interface for CakePHP applications

• Host: GitHub
• URL: https://github.com/cakephp/repl
• Owner: cakephp
• License: mit
• Created: 2020-04-23T02:43:22.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-10T04:21:13.000Z (over 2 years ago)
• Last Synced: 2025-05-26T07:21:53.798Z (8 months ago)
• Language: PHP
• Size: 40 KB
• Stars: 6
• Watchers: 18
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# REPL plugin for CakePHP

![Build Status](https://github.com/cakephp/repl/actions/workflows/ci.yml/badge.svg?branch=master)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)

[![Total Downloads](https://img.shields.io/packagist/dt/cakephp/repl.svg?style=flat-square)](https://packagist.org/packages/cakephp/repl)

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](https://getcomposer.org).

Run the following command

```sh

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:

```php

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](https://book.cakephp.org/4/en/console-commands/repl.html).