Revision: Fri, 31 May 2024 16:10:39 GMT
v1.0 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.12
Edit this page

Console Dispatcher

Spiral Console dispatcher built at top of powerful Symfony Console component and provides ability to register console commands using automatic Tokenizer class lookup.

You are able to register native Symfony Commands in your CLi application.

Running CLI

To get access to Spiral CLI you must execute php webroot/index.php {command} from your root folder. Thought, there is two file shortcuts for Windows and Unix systems which will simplify that command to spiral {command} or ./spiral {command}.

Do not forget to give executable permission to 'spiral' file. In addition, you might rename spiral.bat and spiral file into project specific names.

Execute commands outside of CLI environment

As in case with HttpDispatcher you can get access to ConsoleDispatcher and it's commands at any moment, let's try to execute 'help' command from our controller:

protected function indexAction()

You can provide custom Input and Output interfaces into command method or even specify parameters via array:

  dump($this->console->run('command', [
    'name' => 'Some value' 

External Access

In some cases you might want to get access to Symfony Console application without letting spiral to start, this can be achieved following way (see index.php file):

//Initiating shared container, bindings, directories and etc
$application = App::init([
    'root'        => $root,
    'libraries'   => $root . 'vendor/',
    'application' => $root . 'app/',
    //other directories calculated based on default pattern, @see Core::__constructor()

//Let's NOT start!

//Symfony Console instance with App specific commands


By default, ConsoleDispatcher is able to locate command automatically, you can always alter it's behaviour by modifying console config:

return [
     * When set to true console will try to locate commands automatically using Tokenizer.
    'locateCommands'    => true,

     * Manually registered set of commands. Use this section when locateCommands is off.
    'commands'          => [],

     * This set of commands will be executed when command "configure" run. You can declare command
     * options, header and footer.
    'configureSequence' => [
        'views:compile' => ['options' => []],
        'ide-helper'    => ['options' => [], 'header' => "\nGenerating IDE helper classes..."],


     * Set of commands executed inside "update" command.
    'updateSequence'    => [
        'odm:schema' => ['options' => []],
        'orm:schema' => ['options' => []],

Located commands are cached in static application cache, if you want re-locate commands execute console:reload in your terminal.