craft-cli/cli

Command line interface for Craft CMS

Craft CLI

Command line interface for Craft CMS., _(*1)

Installation

If you are on Mac, you should install via Homebrew., _(*2)

brew tap rsanchez/homebrew-craft-cli
brew install craft-cli

Otherwise, you should download the phar: https://github.com/rsanchez/craft-cli/releases/latest, _(*3)

php craft.phar <your:command>

See Composer Installation for alternate ways to install., _(*4)

Usage

If you are using a multi-environment config, you must specify your environment either using the --environment= flag on your commands, or set the CRAFT_ENVIRONMENT env variable., _(*5)

craft --environment="mysite.dev" show:config

CRAFT_ENVIRONMENT="mysite.dev" craft show:config

Craft CLI is dotenv aware, and will automagically load environment variables from a .env file in your project root (path can be customised via .craft-cli.php). You may set your Craft environment by setting a CRAFT_ENVIRONMENT variable in your .env file., _(*6)

Commands

• assets:pull
• assets:push
• clear:cache
• console
• db:backup
• db:create
• db:pull
• db:push
• db:restore
• download
• generate:command
• help
• init
• install
• install:plugin
• list
• rebuild:searchindexes
• run:tasks
• show:config
• tail
• update:assetsindexes

Assets Pull

Pull Asset files from a remote environment., _(*7)

craft assets:pull --ssh-host=your.remote.server.com --ssh-user=yourUserName yourRemoteEnvironmentName

Assets Push

Push Asset files to a remote environment, _(*8)

craft assets:push --ssh-host=your.remote.server.com --ssh-user=yourUserName yourRemoteEnvironmentName

Clear Cache

Clear all Craft caches., _(*9)

craft clear:cache

Select which cache(s) to clear from an interactive list., _(*10)

craft clear:cache -s

Console

Start an interactive shell., _(*11)

craft console

DB Backup

Backup your database to craft/storage/backups., _(*12)

craft db:backup

Backup your database to the specified path., _(*13)

craft db:backup ./backup.sql

DB Create

Create a database, _(*14)

craft db:create --host=localhost --port=3306 --name=yourDbName --user=yourUserName --password=yourPassword

DB Pull

Pull a remote database to the local database., _(*15)

craft db:pull --ssh-host=your.remote.server.com --ssh-user=yourUserName --force yourRemoteEnvironmentName

DB Push

Push your local database to a remote database., _(*16)

craft db:push --ssh-host=your.remote.server.com --ssh-user=yourUserName --force yourRemoteEnvironmentName

DB Restore

Restore the database from the most recent backup from craft/storage/backups., _(*17)

craft db:restore --force

Restore the database from the specified .sql file., _(*18)

craft db:restore --force ./backup.sql

Download Craft

Download Craft to the current directory., _(*19)

craft download

Create the specified directory and download Craft into it., _(*20)

craft download path/to/directory

Generate Command

Generate a custom command file in the specified directory., _(*21)

craft generate:command your:custom_command ./commands/

Generate a custom command file with a namespace., _(*22)

craft generate:command --namespace="YourSite\Command" your:custom_command ./src/YourSite/Command/

Generate a custom command with arguments and options., _(*23)

craft generate:command --options --arguments your_command ./commands/

Help

Display information about a command and its arguments/options., _(*24)

craft help <command>

Init

Create an .craft-cli.php config file in the current directory, _(*25)

craft init

This config file is only necessary if you if you are using Custom Commands or have renamed your craft folder., _(*26)

Install Craft

Download and install Craft to the current directory., _(*27)

craft install

Create the specified directory and install Craft into it., _(*28)

craft install path/to/directory

Install Plugin

Install a plugin from a GitHub repository., _(*29)

craft install:plugin pixelandtonic/ElementApi

List

List the available commands., _(*30)

craft list

Rebuild Search Indexes

craft rebuild:searchindexes

Run Tasks

Run all pending tasks., _(*31)

craft run:tasks

Reset "running" (stalled) tasks and then run all tasks., _(*32)

craft run:tasks --reset-running

Reset failed tasks and then run all tasks., _(*33)

craft run:tasks --reset-failed

Show Config

Show all config items., _(*34)

craft show:config

Show the specified config item., _(*35)

craft show:config db.user

Tail

Show a tail of craft.log, _(*36)

craft tail

Update Asset Indexes

craft update:assetsindexes

Configuration

Craft CLI can be configured in two ways. You may use the craft init command to generate a .craft-cli.php file. Or, if you have installed Craft CLI via composer, you may add an extra object to your composer.json and a craft-cli object within the extra object:, _(*37)

{
    "extra": {
        "craft-cli": {
            "commandDirs": {
                "\\Your\\Namespace": "path/to/commands/"
            }
        }
    }
}

Custom Commands

Craft CLI custom commands are Symfony Console Command objects. You can add custom commands to your .craft-cli.php or composer.json config by adding a namespace and folder path to the commandDirs object., _(*38)

You can generate a custom command file using the craft generate:command command., _(*39)

Troubleshooting

Your command-line PHP cannot connect to MySQL

You can test this by running this at the command line (change the DB credentials to your actual credentials):, _(*40)

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., _(*41)

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., _(*42)

Composer Installation

You can install globally:, _(*43)

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:, _(*44)

export PATH=~/.composer/vendor/bin:$PATH

Or, you can install on a per project basis, rather than globally to your host system., _(*45)

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:, _(*46)

vendor/bin/craft <your:command>