Command line interface for Craft CMS.
If you are on Mac, you should install via Homebrew.
brew tap rsanchez/homebrew-craft-cli
brew install craft-cli
Otherwise, you should download the phar: https://github.com/rsanchez/craft-cli/releases/latest
php craft.phar <your:command>
See Composer Installation for alternate ways to install.
Clear all Craft caches.
craft clear:cache
Select which cache(s) to clear from an interactive list.
craft clear:cache -s
Start an interactive shell.
craft console
Backup your database to craft/storage.
craft db:backup
Generate a custom command file in the specified directory.
craft generate:command your:custom_command ./commands/
Generate a custom command file with a namespace.
craft generate:command --namespace="YourSite\Command" your:custom_command ./src/YourSite/Command/
Generate a custom command with arguments and options.
craft generate:command --options --arguments your_command ./commands/
Display information about a command and its arguments/options.
craft help <command>
Create an .craft-cli.php config file in the current directory
craft init
This config file is only necessary if you if you are using Custom Commands or have renamed your craft folder.
Install Craft to the current directory.
craft install
Create the specified directory and install Craft into it.
craft install path/to/directory
Install a plugin from a GitHub repository.
craft install:plugin pixelandtonic/ElementApi
List the available commands.
craft list
Show all config items.
craft show:config
Show the specified config item.
craft show:config db.user
Craft CLI custom commands are Symfony Console Command objects. You can add custom commands to your .craft-cli.php config file by adding the class name to the commands array, or by adding a folder path to the commandDirs array.
You can generate a custom command file using the craft generate:command command.
You can test this by running this at the command line (change the DB credentials to your actual credentials):
php -r "var_dump(@mysql_connect('hostname', 'username', 'password', 'database_name'));"
If this prints false, then you know that your CLI PHP is not configured to connect to your database. This is frequently caused by an incorrect default MySQL socket setting.
If you are running MAMP, for instance, and are using the stock Mac OS command-line PHP, you will not be able to connect out-of-the-box. You will need to edit your /etc/php.ini (or wherever your php.ini file is located) file and change the mysql.default_socket and/or the mysqli.default_socket to /Applications/MAMP/tmp/mysql/mysql.sock.
You can install globally:
composer global require craft-cli/cli
Make sure your global composer installation is added to your PATH in your ~/.bash_profile (or ~/.profile or ~/.bashrc or ~/.zshrc) so that you may run the binary from the command line:
export PATH=~/.composer/vendor/bin:$PATH
Or, you can install on a per project basis, rather than globally to your host system.
composer require craft-cli/cli
Then the command would be found in your vendor/bin folder, so you'd run this at your command line:
vendor/bin/craft <your:command>