Overview
Statamic's CLI commands are built with Laravel's Artisan Console package. To view the list of Statamic-specific commands, you may use the please list command:
php please listTo see all commands available, including those provided by Laravel, use the artisan list command.
php artisan listArtisan vs Please
There is no functional difference between Artisan and Please. please is merely an alias for php artisan statamic:. We just think manners are still important and it feels nice to treat your command line with respect, while saving you a little time typing.
# These are equivalentphp please make:userphp artisan statamic:make:userEvery command also includes a help screen which displays and describes the command's available arguments and options. To view a help screen, precede the name of the command with help:
php please help make:userAvailable Commands
You can see the list of available commands in your terminal by running php please list. But for those who don't feel like it, haven't installed yet, or are scared of the command line, here they are also.
| Command | Description |
|---|---|
addons:discover |
Rebuild the cached addon package manifest |
assets:generate-presents |
Generate asset preset manipulations |
assets:meta |
Generate asset metadata files |
auth:migration |
Generate Auth Migrations |
glide:clear |
Clear the Glide image cache |
install |
Install Statamic |
list |
List all the Statamic commands |
make:action |
Create a new action addon |
make:addon |
Create a new addon |
make:filter |
Create a new filter addon |
make:fieldtype |
Create a new fieldtype addon |
make:modifier |
Create a new modifier addon |
make:scope |
Create a new query scope addon |
make:tag |
Create a new tag addon |
make:user |
Create a new user account |
make:widget |
Create a new widget addon |
multisite |
Converts from a single to multisite installation |
site:clear |
Start a fresh site, wiping away all content |
search:insert |
Insert an item into its search indexes |
search:update |
Update a search index |
stache:clear |
Clear the "Stache" cache |
stache:doctor |
Diagnose any problems with the Stache. |
stache:refresh |
Clear and rebuild the "Stache" cache |
stache:warm |
Build the "Stache" cache |
starter-kit:export |
Export a starter kit package |
starter-kit:install |
Install a starter kit |
static:clear |
Clear the static page cache |
static:warm |
Warm the static cache by crawling all URLs |
support:details |
List useful details to help with support |
support:zip-blueprint |
Create a zip file with a blueprint and all fieldset imports |
updates:run |
Run update scripts from a specific version |
Additional Reading
Read more about Artisan at Laravel.com.
