svkurowski/yii2-shell

An interactive shell for Yii 2 projects.


Keywords
console, shell, REPL, yii2
License
MIT

Documentation

An interactive shell for Yii 2

Latest Stable Version Total Downloads License

This extension for Yii framework 2.0 applications provides access to an interactive shell for development and debugging. It wraps the awesome psysh application for easy access via the Yii console.

The extension is released under the MIT License.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --dev --prefer-dist svkurowski/yii2-shell

or add

"svkurowski/yii2-shell": "~1.0.0"

to the require-dev section of your composer.json.

Usage

After installation, you will be able to run the interactive shell via command line:

# Change path to your application's root directory
cd path/to/myapp

# Start the interactive shell
./yii shell

You can access the application object using $this or Yii::$app. Additionally you have access to all your and your dependencies' classes.

See psysh's website for a list of available features.