mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-06-16 05:13:54 -07:00
c6ac9a9f94
# Changelog The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## Changed - Update line length limit from 500 characters to 120 characters. ## Fixed - Most instances of these lint issues: 1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)). 2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)). 3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)). 4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)). Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org> Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623 Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org> Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org> Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
141 lines
5.8 KiB
Markdown
141 lines
5.8 KiB
Markdown
---
|
||
eleventyNavigation:
|
||
key: InstallGit
|
||
title: Install Git
|
||
parent: GettingStarted
|
||
order: 25
|
||
---
|
||
|
||
Projects on Codeberg use [Git](https://git-scm.com/) as their
|
||
[version control](https://git-scm.com/book/en/v2/Getting-Started-About-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](https://git-scm.com/downloads),
|
||
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](https://git-scm.com/download/linux)
|
||
to get the right command for your distro.
|
||
|
||
Please see also the article [Configuring Git](/git/configuring-git), which describes how to set up your name and email
|
||
address for Git.
|
||
|
||
## macOS
|
||
|
||
There are [several ways](https://git-scm.com/download/mac) 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](https://brew.sh/).
|
||
|
||
Once you've installed Homebrew, you can install Git from your terminal using the following command.
|
||
|
||
```bash
|
||
% brew install git
|
||
```
|
||
|
||
### Update
|
||
|
||
To update Git, run the following command.
|
||
|
||
```bash
|
||
% brew upgrade git
|
||
```
|
||
|
||
### Configure
|
||
|
||
Git is now up and running. Please proceed as described in the article [Configuring Git](/git/configuring-git) to set up
|
||
your name and email address for Git.
|
||
|
||
## Windows 10
|
||
|
||
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](#git-clients)), e.g. [RStudio](https://rstudio.com/), 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:
|
||
|
||
<img src="/images/getting-started/install-git/win-run-as-admin.png" alt="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:<br>
|
||
By default, [Vim](https://www.vim.org/) will be used for Git. If you prefer to use another editor, select it here.
|
||
|
||
<img src="/images/getting-started/install-git/win-editor.png" alt="win-editor">
|
||
|
||
2. PATH environment:
|
||
This ensures that Git can be used by 3rd party software ([Git clients](#git-clients)).
|
||
PATH adjustment is recommended (and the default).
|
||
|
||
<img src="/images/getting-started/install-git/win-path.png" alt="win-path">
|
||
|
||
3. 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/Codeberg credentials will be stored in Windows' [Credential Manager](https://support.microsoft.com/en-us/help/4026814/windows-accessing-credential-manager)
|
||
when you enter them for your first pull/push (see [Clone & Commit via HTTP](/git/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.
|
||
|
||
<img src="/images/getting-started/install-git/win-cred-helper.png" alt="win-cred-helper">
|
||
|
||
> 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`.
|
||
>
|
||
> <img src="/images/getting-started/install-git/win-error-notes.png" alt="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](#git-clients), 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](/git/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:
|
||
|
||
```bash
|
||
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.
|
||
|
||
> Make sure that you run the new installer with the same permissions (Administrator or standard user) as the original
|
||
> installation. If 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](https://git-scm.com/downloads/guis).
|