Git - Configuration

Configuration of Git

After installing Git, configuration is a crucial step that tailors Git to work according to your preferences and environment. Git configuration allows you to set user identity, define aliases, choose a default editor, manage merge tools, handle file line endings, and more. This document provides a comprehensive guide to Git configuration, covering global and repository-level settings, configuration files, common parameters, and best practices.

Understanding Git Configuration Levels

Git allows settings to be applied at different levels:

• System Level: Applies to all users on the system. Located at /etc/gitconfig.
• Global Level: Applies to the current user. Stored in the user’s home directory, usually ~/.gitconfig.
• Local Level: Applies to the current repository. Stored in .git/config within the repository.

View Git Configuration

git config --list

View Specific Scope

git config --system --list
git config --global --list
git config --local --list

View Value of a Specific Key

git config user.name

Setting User Information

Set User Name and Email

git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

Override for a Specific Repository

cd myproject/
git config user.name "Project Specific Name"
git config user.email "project.email@example.com"

Check Current Settings

git config --global user.name
git config --global user.email

Configuring Default Text Editor

Set Nano as Default

git config --global core.editor "nano"

Set VS Code as Default

git config --global core.editor "code --wait"

Set Vim as Default

git config --global core.editor "vim"

Working with Aliases

Aliases simplify frequently used commands.

Common Aliases

git config --global alias.co checkout
git config --global alias.br branch
git config --global alias.cm commit
git config --global alias.st status
git config --global alias.last 'log -1 HEAD'

Usage

git co main
git br
git cm -m "New commit"
git last

Core Git Settings

Enable Colored Output

git config --global color.ui auto

Set Default Branch Name

git config --global init.defaultBranch main

Enable Filemode

git config --global core.fileMode false

Enable Symlinks

git config --global core.symlinks true

Line Ending Configuration

Handling line endings is important when working across Windows and UNIX systems.

Convert CRLF to LF on Commit (Recommended on Windows)

git config --global core.autocrlf true

Do Not Modify Line Endings (Recommended on UNIX/macOS)

git config --global core.autocrlf input

Disable Conversion

git config --global core.autocrlf false

Global Git Ignore File

Create a Global Ignore File

touch ~/.gitignore_global

Add Patterns

# Inside ~/.gitignore_global
*.log
.DS_Store
node_modules/
.env

Set the Global Ignore

git config --global core.excludesfile ~/.gitignore_global

Merge and Diff Tools

Set a Merge Tool

git config --global merge.tool meld

Set a Diff Tool

git config --global diff.tool meld

Use External GUI Tool

git mergetool
git difftool

Credential Management

Enable Credential Helper (cache for 15 minutes)

git config --global credential.helper cache

Set Cache Timeout (e.g., 1 hour)

git config --global credential.helper 'cache --timeout=3600'

Store Credentials Permanently (insecure)

git config --global credential.helper store

GPG Signing of Commits

Enable GPG Signing

git config --global commit.gpgsign true

Set GPG Key

git config --global user.signingkey ABC123456789

Check If a Commit is Signed

git log --show-signature

SSH Configuration

Use SSH Instead of HTTPS

git remote set-url origin git@github.com:username/repo.git

Configure SSH Key

ssh-keygen -t rsa -b 4096 -C "you@example.com"
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa

Git Templates

Set a Custom Template Directory

git config --global init.templateDir '~/.git-template'

Create a Hook in Template Directory

mkdir -p ~/.git-template/hooks
echo -e "#!/bin/sh\necho 'New repo created!'" > ~/.git-template/hooks/post-init
chmod +x ~/.git-template/hooks/post-init

Initialize a New Repo Using Template

git init

Managing Configuration Files Directly

Open Global Config

nano ~/.gitconfig

Sample Content of .gitconfig

[user]
    name = John Doe
    email = john@example.com
[core]
    editor = nano
    autocrlf = input
[color]
    ui = auto
[alias]
    co = checkout
    br = branch
    cm = commit
    st = status
[credential]
    helper = store

Advanced Configuration Options

Enable Rebase by Default on Pull

git config --global pull.rebase true

Show Only One-Line Logs

git config --global format.pretty oneline

Set Pager for Logs

git config --global core.pager 'less -F -X'

Resetting Configuration

Unset a Config Value

git config --global --unset user.name

Remove All Global Configuration

rm ~/.gitconfig

Remove Repository Configuration

rm .git/config

Scope Precedence

Git checks configuration in the following order:

1. Repository (.git/config)
2. Global (~/.gitconfig)
3. System (/etc/gitconfig)

Customizing Git Prompt (Optional)

Enable Git Prompt in Bash

echo 'source /usr/share/git/git-prompt.sh' >> ~/.bashrc
echo 'PS1='\''[\u@\h \W$(__git_ps1 " (%s)")]\\$ '\'' ' >> ~/.bashrc
source ~/.bashrc

Best Practices

• Always configure username and email before committing
• Use aliases for productivity
• Use a secure credential manager
• Set global ignore rules
• Enable GPG signing for secure commits

Git configuration allows you to personalize your development environment, secure your repositories, and streamline daily operations. By setting your username, editor, aliases, credentials, merge tools, and more, you can drastically improve productivity and avoid common pitfalls. Understanding how to control configuration at various levels (local, global, system) is key to managing complex projects and teams effectively.

Once configured, Git becomes not just a tool, but a powerful extension of your workflow. Take the time to explore and refine your Git settings for a more efficient and secure development experience.