Revision: Thu, 25 May 2023 17:19:21 GMT
v3.0 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.7
Edit this page

Console Commands

The framework exposes the number of commands to control the build and help in development.

To list all available console commands use the following command:

php app.php

To get help about any specific command:

php app.php help db:table

Alternative:

php app.php db:table -h

Note
You can read how to create your own commands in the following sections.

Aliases

Spiral Console is based on Symfony/Console, it means you can use short command names as long as there is enough information to find the target command:

# can be resolved into `update`
php app.php up 

# Collides with `configure`, `cache:clean`, `cycle:*` commands.
php app.php c

Configure

Your application includes one main command configure. This command will run the sequence of operations to ensure that the application is properly installed, create needed directions and verify permissions to the resources.

To run this command in verbose mode:

php app.php configure -vv

Note
Always run configure before running a newly installed application.

Application Server

The application server (RoadRunner) includes its own set of commands. To list all the available server commands, run:

./rr

Note
You can read more about server commands here.