Grav comes with a built-in command-line interface (CLI) which can be found at
bin/grav. The CLI is extremely useful for running recurring tasks such as clearing the cache, making backups, and more.
Accessing the CLI is a simple process but you need to use a terminal. On a mac this is called
Terminal, on windows, it's called
cmd and on Linux, it's just a shell. UNIX style commands are not natively available in Windows cmd. Installing the msysgit package on a Windows machine adds Git and Git BASH, which is an alternative command prompt that makes UNIX commands available. If you are accessing your server remotely, you most likely will use SSH to remotely log in to your server. Check out this great tutorial for more information on SSH.
Although some operations can be performed manually, by relying on the CLI, these tasks could be automated via cronjobs that run daily.
To get a list of all the commands available in Grav, you can run the command:
This should display something like:
Available commands: backup Creates a backup of the Grav instance cache [clearcache|cache-clear] Clears Grav cache clean Handles cleaning chores for Grav distribution composer Updates the composer vendor dependencies needed by Grav. help Displays help for a command install Installs the dependencies needed by Grav. Optionally can create symbolic links list Lists commands logviewer Display the last few entries of Grav log new-project [newproject] Creates a new Grav project with all the dependencies installed sandbox Setup of a base Grav system in your webroot, good for development, playing around or starting fresh scheduler Run the Grav Scheduler. Best when integrated with system cron security Capable of running various Security checks
To get help for a specific command, you can prepend help to the command:
bin/grav help install
The Grav backup system has been completely revamped in Grav 1.6 to support multiple backup profiles. These profiles are configures in the
user/config/backups.yaml. If you don't have a custom configuration file, Grav will use the default one provided in
If Grav detects multiple backup profiles, the CLI command will prompt you to choose the one you wish to backup with the CLI command.
cd ~/workspace/portfolio bin/grav backup Grav Backup =========== Choose a backup?  Default Site Backup  Pages Backup
Alternatively you can pass an index of the profile directly:
$ cd ~/workspace/portfolio bin/grav backup 1 Archiving 36 files [===================================================] 100% < 1 sec Done... [OK] Backup Successfully Created: /users/joe/workspace/portfolio/backup/pages_backup--20190227120510.zip
More information on the backup functionality can be found in the Advanced -> Backups section.
This CLI command is primarily used during the package building process, as it removes extraneous files and folders from Grav. It is strongly recommended you do not use this yourself unless you are using it build your own Grav packages.
You can clear the cache by deleting all the files and folders under
The equivalent CLI command is:
$ cd ~/webroot/my-grav-project bin/grav cache
There are several aliases for compatibility (
The default option is the standard cache clearing process however, you can control this further with these options:
--purge If set purge old caches --all If set will remove all including compiled, twig, doctrine caches --assets-only If set will remove only assets/* --images-only If set will remove only images/* --cache-only If set will remove only cache/* --tmp-only If set will remove only tmp/*
If you installed Grav via GitHub and have manually installed composer-based vendor packages, you can easily update with:
You can also pass composer options such as
bin/grav composer --install
bin/grav composer --update
These all use the
--no-dev composer option, so to be able to perform testing you should use composer directly:
To install the dependencies Grav relies on (error plugin, problems plugin, antimatter theme), launch a terminal or console and navigate to the grav folder where you want to install the dependencies and run the CLI command.
$ cd ~/webroot/my-grav-project bin/grav install
You should now have the dependencies installed under:
As part of Grav 1.6, a new logviewer CLI command was created to allow for quick viewing of Grav logs.
The simplest way to use this command is to simply type:
cd ~/webroot/my-grav-project bin/grav logviewer
This will output the last 20 log entries of the
logs/grav.log file. There are a few options:
-f, --file[=FILE] custom log file location (default = grav.log) -l, --lines[=LINES] number of lines (default = 10) -v, --verbose verbose output including a stack trace if available
bin/grav logviewer --lines=4 [12:27:20] Log Viewer ========== viewing last 4 entries in grav.log 2019-02-27 12:00:30 [WARNING] Plugin 'foo-plugin' enabled but not found! Try clearing cache with `bin/grav cache` 2019-02-27 12:04:57 [NOTICE] Backup Created: /Users/joe/my-grav-project/backup/default_site_backup--20190227120450.zip 2019-02-27 12:05:10 [NOTICE] Backup Created: /Users/joe/my-grav-project/backup/pages_backup--20190227120510.zip 2019-02-27 12:26:00 [NOTICE] Backup Created: /Users/joe/my-grav-project/backup/pages_backup--20190227122600.zip
And verbose output with stack traces:
bin/grav logviewer -v [16:12:12] Log Viewer ========== viewing last 20 entries in grav.log 2019-03-14 05:52:44 [WARNING] Plugin 'simplesearch.bak' enabled but not found! Try clearing cache with `bin/grav clear-cache` 2019-03-14 05:52:44 [CRITICAL] A function must be an instance of \Twig_FunctionInterface or \Twig_SimpleFunction. 0 /Users/joe/my-grav-project/plugins/acme-twig-filters/acme-twig-filters.php(52): Twig\Environment->addFunction(Object(Twig\TwigFilter)) 1 /Users/joe/my-grav-project/vendor/symfony/event-dispatcher/EventDispatcher.php(212): Grav\Plugin\ACMETwigFiltersPlugin->onTwigInitialized(Object(RocketTheme\Toolbox\Event\Event), 'onTwigInitializ...', Object(RocketTheme\Toolbox\Event\EventDispatcher)) 2 /Users/joe/my-grav-project/vendor/symfony/event-dispatcher/EventDispatcher.php(44): Symfony\Component\EventDispatcher\EventDispatcher->doDispatch(Array, 'onTwigInitializ...', Object(RocketTheme\Toolbox\Event\Event)) 3 /Users/joe/my-grav-project/vendor/rockettheme/toolbox/Event/src/EventDispatcher.php(23): Symfony\Component\EventDispatcher\EventDispatcher->dispatch('onTwigInitializ...', Object(RocketTheme\Toolbox\Event\Event)) 4 /Users/joe/my-grav-project/system/src/Grav/Common/Grav.php(365): RocketTheme\Toolbox\Event\EventDispatcher->dispatch('onTwigInitializ...', Object(RocketTheme\Toolbox\Event\Event)) 5 /Users/joe/my-grav-project/system/src/Grav/Common/Twig/Twig.php(175): Grav\Common\Grav->fireEvent('onTwigInitializ...') 6 /Users/joe/my-grav-project/system/src/Grav/Common/Processors/TwigProcessor.php(24): Grav\Common\Twig\Twig->init() 7 /Users/joe/my-grav-project/system/src/Grav/Framework/RequestHandler/Traits/RequestHandlerTrait.php(45): Grav\Common\Processors\TwigProcessor->process(Object(Nyholm\Psr7\ServerRequest), Object(Grav\Framework\RequestHandler\RequestHandler)) 8 /Users/joe/my-grav-project/system/src/Grav/Framework/RequestHandler/Traits/RequestHandlerTrait.php(57): Grav\Framework\RequestHandler\RequestHandler->handle(Object(Nyholm\Psr7\ServerRequest)) 9 /Users/joe/my-grav-project/system/src/Grav/Common/Processors/AssetsProcessor.php(28): Grav\Framework\RequestHandler\RequestHandler->handle(Object(Nyholm\Psr7\ServerRequest)) 2019-03-14 05:52:46 [WARNING] Plugin 'simplesearch.bak' enabled but not found! Try clearing cache with `bin/grav clear-cache` ...
Every time you want to start a new project with Grav, you need to start with a clean Grav instance. Through the CLI, this process is super easy and takes only a few seconds.
bin/grav new-project ~/webroot/portfolio
This will create a new Grav instance and download all the dependencies required.
Grav has a nifty utility called
sandbox, which can quickly create a symlinked copy of the Grav-installation. Simply put, running
bin/grav sandbox -s DESTINATION - where "DESTINATION" is the path to the folder where you want the copied installation - recreates the Grav-installation in another folder.
For example, running:
bin/grav sandbox -s ../copy
From your current Grav-folder creates a sibling-folder named
copy, where the following folders are virtual copies:
/bin, /system, /vendor, /webserver-configs, as well as standard files that typically reside in Grav's root-folder. All content in /user will be carbon copies, not virtual, so you can easily get started with customizing the new installation without having created overhead from core files.
As outlined in the Advanced -> Scheduler section, The scheduler can be monitored via the CLI command.
The base command will manually run the scheduler tasks that are due:
To get some more detail you can run with the optional
bin/grav scheduler -v Running Scheduled Jobs ====================== [2019-02-27T12:34:07-07:00] Success: Grav\Common\Cache::purgeJob [2019-02-27T12:34:07-07:00] Success: Grav\Common\Cache::clearJob [2019-02-27T12:34:07-07:00] Success: ls -lah
Other options include:
-i, --install Show Install Command -j, --jobs Show Jobs Summary -d, --details Show Job Details
Please refer to the Advanced -> Scheduler section, for more detailed information on these options.
Added in Grav 1.5 is a new security scanner CLI command. You can run this to quickly scan your contents against the configured security settings.
bin/grav security [12:34:12] Grav Security Check =================== Scanning 11 pages [===================================================] 100% < 1 sec [OK] Security Scan complete: No issues found...
To determine if your server is running
cgi-fcgi on the command line, type the following:
$ php -v PHP 5.5.17 (cgi-fcgi) (built: Sep 19 2014 09:49:55) Copyright (c) 1997-2014 The PHP Group Zend Engine v2.5.0, Copyright (c) 1998-2014 Zend Technologies with the ionCube PHP Loader v4.6.1, Copyright (c) 2002-2014, by ionCube Ltd.
If you see a reference to
(cgi-fcgi) you will need to prefix all
bin/grav commands with
php-cli. Alternatively, you can set up an alias in your shell with something like:
alias php="php-cli" which will ensure the CLI version of PHP runs from the command line.
Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to make your changes.