Built-in Commands

UserFrosting's CLI, or Command-line Interface, is called the Bakery. It provides a number of helpful commands that can assist you while you build, manage and install your application. To view a list of all available Bakery commands, you may use the list command from your UserFrosting root directory:

$ php bakery list

Every command also includes a "help" screen which displays and describes the command's available arguments and options. To view a help screen, simply precede the name of the command with help:

$ php bakery help [command]

General help can also be displayed by running:

$ php bakery help

Available commands

bake

Bake is the general installation command. It combines setup:db, setup:mail, debug, migrate, create:admin-user, webpack and clear-cache into a single command:

$ php bakery bake

clear-cache

The clear-cache command takes care of deleting all the cached data. See Chapter 17 for more information.

$ php bakery clear-cache

create:admin-user

The create:admin-user command is used to create a new root user. This command will self-abort if the root user already exists.

$ php bakery create:admin-user [options]

Options can also be used to create the admin user without interaction (See the table below for the list of available options). For example :

$ php bakery create:admin-user --username="admin" --email="[email protected]" --password="adminadmin12" --firstName="Admin" --lastName="istrator"

create:user

This command is the same as create:admin-user, but will create a non-root user.

$ php bakery create:user [options]

debug

The debug command will run a series of tests to make sure everything is ready to run UserFrosting on your system. If you have trouble accessing your UserFrosting installation, you should run this command first to make sure basic requirements are met.

The information displayed by this command can also be useful to other people when asking for help and submitting new issues on GitHub.

$ php bakery debug

The verbose option can be used with this command to display even more information.

$ php bakery debug -v

The debug command is in fact an aggregator of sub-commands, similar to bake. It include the following command by default:

Some will be only displayed when the verbose mode is active.

locale:compare

This command compare two locales dictionaries. A list of all locale keys found in the left locale and not found in the right locale will be generated, as well as a list of all keys with empty values and/or duplicate values. This can be helpful to list all values in a specific languages that are present, but might need translation.

$ php bakery locale:compare [options]

This command is interactive, which mean it will ask for which locales to compare. Options can also be used to automatically compare the two locales without user interaction (See the table below for the list of available options). à This command will display :

• Comparison between Right and Left locales : Returns al list of all differences in both locales using array_diff_assoc. This can be used to compare the two locales.
• Missing keys from Right found in Left : This can be used to see which keys are missing in the Right locale, but that can be found in the Left locale, so they can be added.
• Same values found in both Left and Right locale : This can be used to find strings in the right locale that is the same in the left locale. When two locale have the same string value, it may means the string is not translated in the right locale.
• Empty values for Right locale : List keys with empty string for the right locale. These strings might need to be filled in.

For example :

$ php bakery locale:compare -l en_US -r fr_FR

locale:dictionary

This command shows the compiled dictionary for the selected locale.

$ php bakery locale:dictionary [options]

This command is interactive, which mean it will ask to select the locale to show the dictionary from. Options can also be used to automatically select the locale without user interaction (See the table below for the list of available options).

For example :

$ php bakery locale:dictionary -l fr_FR

locale:info

This command list all available locale as well as the default locale.

$ php bakery locale:info

Example output :

+------------+----------------------+----------------------+---------+---------+
| Identifier | Name                 | Regional             | Parents | Default |
+------------+----------------------+----------------------+---------+---------+
| en_US      | English              | English              |         | Yes     |
| es_ES      | Spanish              | Español              | en_US   |         |
| de_DE      | German               | Deutsch              | en_US   |         |
| fr_FR      | French               | Français             | en_US   |         |
+------------+----------------------+----------------------+---------+---------+

migrate

The migrate command runs all the pending database migrations. Migrations consist of special PHP classes used to manipulate the database structure and data, creating new tables or modifying existing ones. UserFrosting comes with a handful of migrations to create the default tables. The built-in migrations also handle the changes in the database between versions. See the Migrations section for more information about migrations.

$ php bakery migrate [options]

The pretend option can be used to test migrations. This will display the underlying SQL queries:

$ php bakery migrate --pretend

Result :

UserFrosting\Sprinkle\Core\Database\Migrations\v400\SessionsTable
> select * from information_schema.tables where table_schema = ? and table_name = ?
> create table `sessions` (`id` varchar(255) not null, `user_id` int null, `ip_address` varchar(45) null, `user_agent` text null, `payload` text not null, `last_activity` int not null) default character set utf8 collate utf8_unicode_ci
> alter table `sessions` add unique `sessions_id_unique`(`id`)

migrate:rollback

The migrate:rollback command allows you to cancel, or rollback, the last migration operation. For example, if something went wrong with the last migration operation or if you made a mistake in your migration definition, you can use that command to undo it.

Note that migrations are run in batches. For example, when running the migrate command, if 4 classes (or migration definitions) are executed, all 4 definitions will be reverted when rolling back the last migration operation, unless you used the step option with the migrate command.

Options can also be used to rollback more than one migration at a time or to rollback a specific migration.

$ php bakery migrate:rollback [options]

migrate:reset

The migrate:reset command is the same as the rollback command, but it will revert every migration. Without options, this is the same as wiping the database to a clean state.

$ php bakery migrate:reset [options]

migrate:reset:hard

The migrate:reset:hard command is the same as the migrate:reset command, but it will bypass all migrations and drop all tables from the database. This can be used as a last resort when a specific migration won't allow you to reset the whole stack.

$ php bakery migrate:reset:hard [options]

migrate:refresh

The migrate:refresh command will rollback the last migration operation and execute it again. This is the same as executing migrate:rollback and then migrate.

$ php bakery migrate:refresh [options]

migrate:status

The migrate:status command will show what migration have been run and which one can be run. It will also display if a ran migration is available, in other words if this migration class was found so it can be rollback.

$ php bakery migrate:status [options]

route:list

Display the list of all registered routes.

$ php bakery route:list [options]

Example result:

$ php bakery route:list --uri=/account/ --method=POST --sort=action

Registered Routes
=================

 -------- ------------------------------ ---------- -------------------------------------------------------------------------------
  Method   URI                            Name       Action
 -------- ------------------------------ ---------- -------------------------------------------------------------------------------
  POST     /account/forgot-password                  UserFrosting\Sprinkle\Account\Controller\AccountController:forgotPassword
  POST     /account/login                            UserFrosting\Sprinkle\Account\Controller\AccountController:login
  POST     /account/settings/profile                 UserFrosting\Sprinkle\Account\Controller\AccountController:profile
  POST     /account/register                         UserFrosting\Sprinkle\Account\Controller\AccountController:register
  POST     /account/resend-verification              UserFrosting\Sprinkle\Account\Controller\AccountController:resendVerification
  POST     /account/set-password                     UserFrosting\Sprinkle\Account\Controller\AccountController:setPassword
  POST     /account/settings              settings   UserFrosting\Sprinkle\Account\Controller\AccountController:settings
 -------- ------------------------------ ---------- -------------------------------------------------------------------------------

seed

The seed command can be used to run any registered seeds classes. See Chapter 12 for more info on database seeds.

$ php bakery seed [options] [--] <class> (<class>)...

If no <class> is specified, an invite will be displayed, prompting you to select one or many registered seed to run.

Multiple seeds classes can be run at one by separating multiple seed classes with a space. For example, to run Class1 and Class2 :

$ php bakery seed Class1 Class2

seed:list

The seed:list command will list all database seeds available. See Chapter 12 for more info on database seeds.

$ php bakery seed:list

Example result:

Seeds List
==========
 * UserFrosting\Sprinkle\Account\Database\Seeds\DefaultGroups
 * UserFrosting\Sprinkle\Account\Database\Seeds\DefaultPermissions
 * UserFrosting\Sprinkle\Account\Database\Seeds\DefaultRoles

setup:db

The setup:db command can be used to setup the database configuration. This configuration will be saved in the app/.env file. This can also be done manually by editing the app/.env file or using global server environment variables. See Environment Variables for more information about these variables.

$ php bakery setup:db [options]

Options can be used to defined each info individually in a non-interactive way (See the table below for the list of available options). For example :

php bakery setup:db --db_driver=mysql --db_name=userfrosting --db_port=3306 --db_host=localhost --db_user=userfrosting --db_password=secret

setup:mail

The setup:mail command can be used to setup the outgoing email configuration. Different setup method can be selected to guide you into configuring outgoing email support. This configuration will be saved in the app/.env file.

As with the database setup, this can also be done manually by editing the app/.env file or using global server environment variables. See Environment Variables for more information about these variables.

$ php bakery setup:mail [options]

Options can also be used to defined each info individually in a non-interactive way. When using one or more option, the "SMTP Server" method will automatically be selected.

setup:env

The setup:env command can be used to select the desired Environment Mode. The default choices are default, production and debug. A custom value can also be defined.

As with the database and outgoing email setup, this can also be done manually by editing the app/.env file or using global server environment variables. See Environment Variables for more information about these variables.

$ php bakery setup:env [options]

Example usage :

php bakery setup:env --mode=production

setup

The setup command combines the setup:db, setup:mail and setup:env commands. This command can't accept any of the option of it's child command.

$ php bakery setup

sprinkle:list

Display the list of all loaded sprinkles. It will also display the base namespace classes from the sprinkle is expected to have, as weel as the expected path.

$ php bakery sprinkle:list

Example result:

 Loaded Sprinkles
================

 ------------------ --------------------------------------- ---------------------------------------------------------------------- 
  Sprinkle           Namespace                               Path                                                                
 ------------------ --------------------------------------- ---------------------------------------------------------------------- 
  Core Sprinkle      UserFrosting\Sprinkle\Core\Core         /home/UserFrosting/vendor/userfrosting/sprinkle-core/app/src/../     
  Account Sprinkle   UserFrosting\Sprinkle\Account\Account   /home/UserFrosting/vendor/userfrosting/sprinkle-account/app/src/../  
  AdminLTE Theme     UserFrosting\Theme\AdminLTE\AdminLTE    /home/UserFrosting/vendor/userfrosting/theme-adminlte/app/src/../    
  Admin Sprinkle     UserFrosting\Sprinkle\Admin\Admin       /home/UserFrosting/vendor/userfrosting/sprinkle-admin/app/src/../    
  My Application     UserFrosting\App\MyApp                  /home/UserFrosting/app/src/../                                       
 ------------------ --------------------------------------- ---------------------------------------------------------------------- 

test

The test command is used to execute PHPUnit tests.

Tests from a specific sprinkle can optionally be run using the 'testscope' argument (eg. php bakery test SprinkleName). A specific test class can also be run using the testscope argument (eg. php bakery test 'UserFrosting\Sprinkle\SprinkleName\Tests\TestClass'), as a specific test method (eg. php bakery test 'UserFrosting\Sprinkle\SprinkleName\Tests\TestClass::method').

See the Automated Testing section for more information.

$ php bakery test [options] [--] [<testscope>]

test:mail

The test:mail command lets you test the email sending capability of your UserFrosting setup by sending a test email. By default, it will send the test email to the admin contact defined the configuration file, but this can be changed using the provided --to options.

$ php bakery test:mail [options]

webpack

The webpack (alias : build-assets) command is an alias for the NPM and Webpack Encore scripts used for asset management. The package.json and webpack.config.js files contains the configuration required to download Javascript, CSS, and other assets used by UserFrosting. This command will install all required frontend dependencies locally, and then automatically compile frontend dependencies to /app/assets.

See the Asset Management chapter for more information about asset bundles and the production option.

$ php bakery webpack [options]