master
10.0 9.1
show older versions 9.0 8.1 8.0 7.3 7.2 7.1 7.0 6.3 6.2 6.1 6.0 5.7 5.6 5.5 5.4 5.3 5.2 5.1 5.0 4.5 3.6
Command line

Command line

Mako includes a command line tool called reactor. Reactor comes with a set of useful commands out of the box and you can also create your own custom commands. Commands are especially useful when creating long running tasks such as cron jobs or queue workers.

Usage

To list the available commands just type the following in your console:

php reactor

It should print something similar to the following on a default Mako installation.

MAKO FRAMEWORK [ 7.1.0 ]

Usage:

php reactor [command] [arguments] [options]

Global arguments and options:

-------------------------------------------------------
| Name    | Description                    | Optional |
-------------------------------------------------------
| command | Command name                   | Yes      |
| --env   | Overrides the Mako environment | Yes      |
| --help  | Displays helpful information   | Yes      |
| --mute  | Mutes all output               | Yes      |
-------------------------------------------------------

Available commands:

----------------------------------------------------------------------------
| Command                | Description                                     |
----------------------------------------------------------------------------
| app:generate-key       | Generates a 256-bit encryption key.             |
| app:generate-preloader | Generates a opcache preloader script.           |
| app:generate-secret    | Generates a new application secret.             |
| app:routes             | Lists all registered routes.                    |
| app:server             | Starts the local development server.            |
| cache:clear            | Clears the cache.                               |
| cache:remove           | Removes the chosen key from the cache.          |
| migration:create       | Creates a new migration.                        |
| migration:down         | Rolls back the last batch of migrations.        |
| migration:reset        | Resets the database schema.                     |
| migration:status       | Checks if there are any outstanding migrations. |
| migration:up           | Runs all outstanding migrations.                |
----------------------------------------------------------------------------

Note that the list of available commands may vary depending on which services you have enabled.

Executing a command is easy and can be done like this:

php reactor app:routes

You can list detailed information about a specific command using the --help flag.

php reactor app:server --help