Skip to content

Install Git

Projects on Forgejo use Git as their version control system. If you want to contribute source code, it's a good idea to install Git at this point.

Git runs on every OS. You can download it directly from the Git website, or from your operating system’s package manager (if available).

Here we provide step-by-step instructions to install it.

Disclaimer: we try to keep these instructions up-to-date, but you might need to adjust them for your machine/OS.

Linux

On Linux, you can install Git directly from your package manager. Check out Git's official documentation to get the right command for your distro.

Please see also the article Configuring Git, which describes how to set up your name and email address for Git.

macOS

There are several ways to install Git on macOS. This guide will show you how to install Git using the Homebrew package manager. You will need to be on macOS High Sierra (10.13) or higher.

Install

You will first need to install Homebrew. You can do this following the instructions on their website.

Once you've installed Homebrew, you can install Git from your terminal using the following command.

% brew install git

Update

To update Git, run the following command.

% brew upgrade git

Configure

Git is now up and running. Please proceed as described in the article Configuring Git to set up your name and email address for Git.

Windows

There are several ways to install Git on Windows. An easy one is to use Git’s install wizard, shown here.

Permissions

For some Git clients (see below), e.g. RStudio, it is recommended to install Git as administrator. It is also possible to install Git as a standard user, but you may have to manually specify the path to the Git executable in the settings of your Git client.

Install

If you want to install Git as a standard user, just log in with your user account and run the installer. To install with administrator permissions, run the installer as administrator. Right-click on the installer, select Run as administrator and enter your credentials:

win-run-admin

From here, follow the steps in the setup wizard. It is okay to just accept the defaults, when in doubt.
Here are some important steps:

  1. Choose your editor:
    By default, Vim will be used for Git. If you prefer to use another editor, select it here.

win-editor

  1. PATH environment: This ensures that Git can be used by 3rd party software (Git clients). PATH adjustment is recommended (and the default).

win-path

  1. Choose credential helper:
    From Git 2.29.0 onwards, the Git Credential Manager Core will be used by default. The Git Credential Manager can still be installed and used, but is now deprecated. When using either of these, your Git/Forgejo credentials will be stored in Windows' Credential Manager when you enter them for your first pull/push (see Clone & Commit via HTTP). Windows' Credential Manager is also where you'd go to change them. Follow the links on the setup wizard for more details.
    If you'd prefer not to store your credentials in Windows but e.g. in a password manager, select the third option (None). You'll have to enter your credentials at every push/pull.

win-cred-helper

Note

You may get the error message displayed below, saying that the release notes cannot be displayed. This can be safely ignored; you can find the release notes in Start Menu → Git → Git Release Notes.

win-error

Run

Git can be used through Command Prompt (the traditional Windows command line interpreter), PowerShell (the "replacement" of Command Prompt), your Git client, or Git Bash. The latter two options are recommended.

Git Bash is what comes with Git. You can access it from the Start Menu: Git → Git Bash.

Configure

You have now managed to get Git up and running. Please proceed as described in the article Configuring Git to set up your name and email address for Git.

Update

If you ticked the box to check for updates during installation, Git will inform you that a new version is available.
To check for updates, at the command line, type:

git update-git-for-windows

After that, just follow the instructions in the terminal to update to the latest version.

Alternatively, you can download the installer from the Git website as explained above.

Warning

Make sure that you run the new installer with the same permissions (Administrator or standard user) as the original installation. If you do not, it will be installed twice and that will create a mess.

If you want to keep all your previous settings, simply tick the box Only show new options in the setup wizard (see screenshots above).

Git clients

Git can be used from the command line as shown above, but it can also be used through graphical user interfaces called Git clients. You can find a list of various Git clients on the Git website.

Attribution
This guide is derived from the Codeberg Documentation, used under CC-BY-SA 4.0.