Go to file
Andy Miller afb5b02e57
Fixes for multilang taxonomy
2024-03-21 15:08:44 -06:00
.github add php 8.3 to test (#3778) 2024-01-05 11:43:34 +00:00
.phan Add a .phan config file and stubs for Phan static analysis 2019-10-16 10:38:08 -07:00
assets Update copyright date 2023-01-02 11:09:32 -07:00
backup Update copyright date 2023-01-02 11:09:32 -07:00
bin updates + changelog 2024-03-18 11:34:37 -06:00
cache Update copyright date 2023-01-02 11:09:32 -07:00
images Update copyright date 2023-01-02 11:09:32 -07:00
logs Update copyright date 2023-01-02 11:09:32 -07:00
system Fixes for multilang taxonomy 2024-03-21 15:08:44 -06:00
tests fix special-chars in titleize - fixes #732 2024-01-19 12:39:24 +00:00
tmp Update copyright date 2023-01-02 11:09:32 -07:00
user Update copyright date 2023-01-02 11:09:32 -07:00
webserver-configs Update dangerous extensions (#3756) 2023-10-24 10:20:22 +01:00
.dependencies Use quark by default 2017-12-29 13:12:18 -07:00
.editorconfig Minor indentation config tweaks 2021-08-18 09:31:15 -07:00
.gitignore Better and generic ignore pattern for `security.yaml` (fixes #3706) 2023-04-06 10:29:35 -07:00
.htaccess Block `.json` files in web server configs 2021-12-08 15:07:42 +02:00
.travis.yml 🎉 Moved Travis releases builds to Github Actions 🎉 2020-12-05 16:53:14 -08:00
CHANGELOG.md Fixes for multilang taxonomy 2024-03-21 15:08:44 -06:00
CODE_OF_CONDUCT.md Updated COC to Contributor Covenant COC v2 2021-02-04 20:46:32 -08:00
CONTRIBUTING.md Remove Gitter, Slack (#2502) 2019-05-14 11:44:27 -06:00
LICENSE.txt Prepare for release 2021-01-19 12:08:10 -07:00
README.md Fixed pimple link #3527 2022-02-08 08:40:59 +02:00
SECURITY.md Update SECURITY.md 2024-03-04 15:55:29 -07:00
codeception.yml Updated unit tests 2020-12-04 20:01:28 +02:00
composer.json Update composer.json 2023-02-23 18:46:44 -07:00
composer.lock updates + changelog 2024-03-18 11:34:37 -06:00
index.php update copyright year 2024-01-05 11:43:52 +00:00
now.json Fixed version history issue 2021-01-14 20:50:40 +02:00
robots.txt Update robots.txt reflecting actual folders (#3625) 2023-03-06 10:21:03 -07:00



PHPStan Discord PHP Tests OpenCollective OpenCollective OpenCollective

Grav is a Fast, Simple, and Flexible, file-based Web-platform. There is Zero installation required. Just extract the ZIP archive, and you are already up and running. It follows similar principles to other flat-file CMS platforms, but has a different design philosophy than most. Grav comes with a powerful Package Management System to allow for simple installation and upgrading of plugins and themes, as well as simple updating of Grav itself.

The underlying architecture of Grav is designed to use well-established and best-in-class technologies to ensure that Grav is simple to use and easy to extend. Some of these key technologies include:



The full documentation can be found from learn.getgrav.org.


These are the options to get Grav:

Downloading a Grav Package

You can download a ready-built package from the Downloads page on https://getgrav.org

With Composer

You can create a new project with the latest stable Grav release with the following command:

$ composer create-project getgrav/grav ~/webroot/grav

From GitHub

  1. Clone the Grav repository from https://github.com/getgrav/grav to a folder in the webroot of your server, e.g. ~/webroot/grav. Launch a terminal or console and navigate to the webroot folder:

    $ cd ~/webroot
    $ git clone https://github.com/getgrav/grav.git
  2. Install the plugin and theme dependencies by using the Grav CLI application bin/grav:

    $ cd ~/webroot/grav
    $ bin/grav install

Check out the install procedures for more information.

Adding Functionality

You can download plugins or themes manually from the appropriate tab on the Downloads page on https://getgrav.org, but the preferred solution is to use the Grav Package Manager or GPM:

$ bin/gpm index

This will display all the available plugins and then you can install one or more with:

$ bin/gpm install <plugin/theme>


To update Grav you should use the Grav Package Manager or GPM:

$ bin/gpm selfupgrade

To update plugins and themes:

$ bin/gpm update

Upgrading from older version


We appreciate any contribution to Grav, whether it is related to bugs, grammar, or simply a suggestion or improvement! Please refer to the Contributing guide for more guidance on this topic.

Security issues

If you discover a possible security issue related to Grav or one of its plugins, please email the core team at contact@getgrav.org and we'll address it as soon as possible.

Getting Started

Exploring More


Support Grav with a monthly donation to help us continue development. [Become a backer]


Support Grav with a monthly donation to help us continue development. [Become a supporter]


Support Grav with a yearly donation to help us continue development. [Become a sponsor]



Running Tests

First install the dev dependencies by running composer install from the Grav root.

Then composer test will run the Unit Tests, which should be always executed successfully on any site. Windows users should use the composer test-windows command. You can also run a single unit test file, e.g. composer test tests/unit/Grav/Common/AssetsTest.php

To run phpstan tests, you should run:

  • composer phpstan for global tests
  • composer phpstan-framework for more strict tests
  • composer phpstan-plugins to test all installed plugins