yiisoft/yii2-shell

The interactive shell extension for Yii framework

, _(*1)

Interactive Shell Extension for Yii 2

This extension provides an interactive shell for Yii framework 2.0 based on psysh., _(*2)

For license information check the LICENSE-file., _(*3)

, _(*4)

Installation

The preferred way to install this extension is through composer., _(*5)

Either run, _(*6)

composer require yiisoft/yii2-shell

or add, _(*7)

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

to the require section of your composer.json., _(*8)

Usage

After installation, you will be able to run the interactive shell via command line:, _(*9)

# 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., _(*10)

See psysh's website for a list of available features., _(*11)

Configuration

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:, _(*12)

'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., _(*13)

Note: updateCheck is explictly set to never by yii2-shell. All other PsySH options use default values., _(*14)

Screenshot

The following screenshot shows a usage example:, _(*15)

, _(*16)