Kirby meets Git
Install and update Kirby via Git
Git is currently the most popular version control system for any kind of software project. A version control system is a bit like a time machine for your code that makes it possible to follow all the changes you've made, work together on the same code in a team and revert mistakes during the development process.
The team behind the Git client Tower have free learning resources on Git. If you are starting out and would like to learn more about version control with Git, check them out: https://www.git-tower.com/learn/
Kirby 3 is now developed using a single Git repository, which is hosted on GitHub. Not only can you follow our development process and contribute your own ideas and code changes there, but you can also use the repository as a Git submodule.
This tutorial describes one of several ways you can install and update Kirby. See the overview page for all supported ways.
The easiest way to install Kirby is the Starterkit. It can be installed with a single line in the terminal. Navigate to the place where you want to install Kirby and clone the Starterkit code with:
git clone https://github.com/getkirby/starterkit.git your-project
You will now have a full Starterkit installation in the
your-project folder. If you point your web server at it, you should already be able to access your site in the web browser.
If you want to be able to update Kirby automatically using Git, you now need to install Kirby as a Git submodule. Run the following commands to do this:
# navigate to the project folder cd your-project # remove the kirby directory as it will be replaced in the next step rm -R kirby git add kirby # install the submodule git submodule add https://github.com/getkirby/kirby.git kirby # commit the changes git commit -m "Setup Kirby as a submodule"
The latest version of Kirby is now installed as a Git submodule.
You can of course do all of those steps in a graphical Git tool if you prefer. We recommend Tower for macOS and Windows, but there are of course several other tools you can use.
If you want to update Kirby to the latest version, all you need to do is to update the submodule like this:
# change into the submodule cd kirby # update to the latest version git checkout master #  git pull # 
 ensures that the submodule is on the
master branch of the Kirby repo. This branch always receives the latest released and stable Kirby version. The command
 then fetches all changes from GitHub and updates the code.
Now you only need to commit the changes to your repo:
# change back into the main project folder cd .. # add the updated Kirby submodule and commit git add kirby git commit -m "Update Kirby"
If you don't want to type all this every time you want to update Kirby, you can add the commands to a simple bash script to make updating even easier:
Save this in the root directory of your site as
update.sh. Make it executable with
chmod +x update.sh
From now on you can update your installation with a single line:
If you want to checkout the development branch to test the latest features, you can do it in the same way:
# change into the submodule cd kirby # update to the development version git checkout develop git pull
Then stage and commit your changes like above. This way, you can easily switch between the
develop and the