This extension provides an interactive shell for Yii framework 2.0 based on psysh.

For license information check the LICENSE-file.

The preferred way to install this extension is through composer.

Either run

composer require yiisoft/yii2-shell 

or add

"yiisoft/yii2-shell": "~2.0.0"

to the require section of your composer.json.

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 Yii::$app. Additionally you have access to all your and your dependencies' classes.

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

You can configure the PsySH shell by setting options via the shellConfig variable in the controller, i.e. add this to your console application configuration:

'controllerMap' => [ 'shell' => [ 'shellConfig' => [ 'updateCheck' => 'weekly', 'verbosity' => \Psy\Configuration::VERBOSITY_VERBOSE, ], ], ], 

See https://github.com/bobthecow/psysh/wiki/Config-options for a list of PsySH configurable options.

Note: updateCheck is explictly set to never by yii2-shell. All other PsySH options use default values.

The following screenshot shows a usage example: