新手文档

Git 教程：第 1 部分, 第 2 部分。

Git 用户手册。日常 Git 与 20 条命令左右。Git 工作流。

高级文档

Git Magic，有多种语言翻译。

Pro Git。关于 Git 的书。在 Amazon 购买或下载 PDF、mobi 或 ePub 格式。它有许多不同语言的翻译。从 GArik 下载俄语翻译。

Git Wiki.

Git Buch（德语）。

离线文档

Git 内置帮助：运行 git help $TOPIC。例如，运行 git help git 或 git help help。

下载和安装

Unix 用户：使用您的包管理器下载并安装。

Microsoft Windows：下载 git-for-windows。

MacOS X：使用 XCode 安装的 Git，或从 MacPorts 或 git-osx-installer 下载，或使用 Homebrew 安装 Git：brew install git。

git-cola（仓库）是一个用 Python 编写并采用 GPL 许可的 Git GUI。支持 Linux、Windows、MacOS X。

TortoiseGit 是一个基于 TortoiseSVN 的 Windows Shell Git 界面；开源。

初始配置

这段简单的代码经常出现在文档中，但它很重要，所以在这里重复一下。Git 在每次提交中存储作者和提交者的姓名/电子邮件，因此请配置您的真实姓名和首选电子邮件

$ git config --global user.name "User Name"
$ git config --global user.email user.name@example.org

更新本地分支和远程跟踪分支

要在不更新本地分支的情况下更新远程跟踪分支，请运行 git remote update [$REMOTE...]。例如

$ git remote update
$ git remote update origin

$ git fetch $REMOTE $BRANCH

$ git fetch $REMOTE $BRANCH:$BRANCH

$ git pull $REMOTE $BRANCH

$ git fetch $REMOTE $BRANCH
$ git merge FETCH_HEAD

$ git fetch origin v1:v1  # Update v1
$ git pull --rebase origin master  # Update the current branch master
                                   # using rebase instead of merge
$ git merge v1

$ git checkout v1
$ git pull --rebase origin v1
$ git checkout master
$ git pull --rebase origin master
$ git merge v1

$ git pull origin

$ git pull

$ git push origin v1 master

$ git push origin v1:v1 master:master

$ git push origin

$ git push

$ git config push.default simple

$ git config push.default matching

$ git fetch origin tag $TAG1 tag $TAG2...

$ git fetch origin tag 1.4.2
$ git fetch origin v1:v1 tag 2.1.7

$ git push origin tag 1.4.2
$ git push origin v1 master tag 2.1.7

$ git push --tags origin

git checkout：恢复文件内容

git checkout，例如，可以用来将文件内容恢复到某个提交。像这样

git checkout HEAD~ README

该命令将 README 文件的内容恢复到当前分支倒数第二个提交。默认情况下，提交 ID 只是 HEAD；即 git checkout README 将 README 恢复到最新提交。

（不要使用 git checkout 来查看提交中的文件内容，请使用 git cat-file -p；例如 git cat-file -p HEAD~:path/to/README）。

git reset：移除（未推送的）提交

git reset 移动当前分支的头部。头部可以移动到指向任何提交，但它通常用于从分支顶部删除一个或几个提交（最好是未推送的），即向后移动分支以撤消几个（未推送的）提交。

git reset 有三种操作模式——软、硬和混合。默认是混合模式。ProGit 解释了 它们之间的区别非常清楚。裸仓库没有索引或工作树，因此在裸仓库中只可能进行软重置。

git reflog：引用日志

使用 git reset 删除提交或移动分支的头部听起来很危险，确实如此。但有一种方法可以撤销：再次重置回原始提交。Git 不会立即删除提交；未引用的提交（在 Git 术语中称为“悬空提交”）会在数据库中停留一段时间（默认为两周），因此您可以重置回它或创建一个指向原始提交的新分支。

对于每次分支头部的移动——无论是通过 git commit、git checkout、git fetch、git pull、git rebase、git reset 等等——Git 都会存储一个引用日志（简称 reflog）。对于每次移动，Git 都会存储头部所在的位置。git reflog 命令可用于查看（和操作）日志。

除了每个分支头部的移动之外，git 还存储 HEAD 的移动——这是一个符号引用，（通常）它表示当前分支。HEAD 通过 git checkout $BRANCH 进行更改。

默认情况下，git reflog 显示 HEAD 的移动，即该命令等效于 git reflog HEAD。要显示分支头部的移动，请使用命令 git reflog $BRANCH。

因此，要撤消 git reset，请在 git reflog 中查找原始提交，使用 git show 或 git log 进行验证，然后运行 git reset $COMMIT_ID。Git 将分支头部的移动存储在 reflog 中，因此您以后可以再次撤消该撤消。

在更复杂的情况下，您可能希望在重置分支头部的同时移动一些提交。将它们樱桃挑选到新分支。例如，如果您想将 master 分支重置回原始提交，但保留当前分支中创建的两个提交，请执行类似操作

$ git branch save-master  # create a new branch saving master
$ git reflog  # find the original place of master
$ git reset $COMMIT_ID
$ git cherry-pick save-master~ save-master
$ git branch -D save-master  # remove temporary branch

git revert：回滚提交

git revert 会回滚一个或多个提交，也就是说，它会创建一个或多个新的提交来回滚给定提交的效果。这是撤消已发布提交的唯一方法（git commit --amend、git rebase 和 git reset 以非快进的方式更改分支，因此它们只应用于未推送的提交。）

回滚合并提交存在问题。git revert 可以撤消合并提交创建的代码，但它无法撤消合并的事实。请参阅讨论 如何回滚错误的合并。

无法撤消的事情

无论您撤销什么，有一件事是无法撤销的——被覆盖的未提交更改。未提交的更改不属于 Git，因此 Git 无法帮助保留它们。

大多数情况下，当您要执行覆盖未提交更改的命令时，Git 会警告您。Git 不允许您使用 git checkout 切换分支。当您在工作区不干净的情况下要进行变基时，它会阻止您。它拒绝在未提交的文件上拉取新提交。

但是有些命令确实会这样做——覆盖工作树中的文件。像 git checkout $PATHs 或 git reset --hard 这样的命令会默默地覆盖文件，包括您的未提交更改。

考虑到这一点，您就可以理解“尽早提交，经常提交”的立场了。尽可能经常提交。在编辑器或 IDE 中每次保存时都提交。您可以在推送之前编辑您的提交——编辑提交消息，更改提交，重新排序，组合，拆分，删除。但请将您的更改保存在 Git 数据库中，要么提交更改，要么至少使用 git stash 将它们暂存起来。

行尾符

Git 内置机制可处理不同行尾样式平台之间的行尾问题。要让 Git 进行 CRLF 转换，请使用 .gitattributes 为文件分配 text 属性。对于必须具有特定行尾的文件，请分配 eol 属性。对于二进制文件，属性自然是 binary。

例如

$ cat .gitattributes
*.py text
*.txt text
*.png binary
/readme.txt eol=CRLF

要检查 Git 为文件使用的属性，请使用 git check-attr 命令。例如

$ git check-attr -a -- \*.py

有用的资源

GitAlias（仓库）是大量的别名集合。仔细选择常用命令的别名可以节省您大量的击键！

GitIgnore 和 https://github.com/github/gitignore 是适用于各种 IDE 和编程语言的 .gitignore 文件集合。包括 Python！

pre-commit（仓库）是一个用于管理和维护多语言 pre-commit 钩子的框架。该框架用 Python 编写，拥有许多用于多种编程语言的插件。

暂存区

暂存区，又称索引或缓存，是 Git 的一个显著特性。暂存区是 Git 在提交补丁之前收集补丁的地方。收集补丁和提交阶段的分离提供了 Git 一个非常有用的功能：您可以在提交之前查看收集到的补丁，甚至可以编辑它们——删除一些代码块，添加新的代码块，然后再次查看。

要将文件添加到索引，请使用 git add。在提交之前收集补丁意味着您需要对每次更改都这样做，而不仅仅是添加新的（未跟踪的）文件。为了简化提交，如果您只想在不审查的情况下提交所有内容，请运行 git commit --all（或简写 -a）——该命令会将每个更改的已跟踪文件添加到索引，然后提交。要提交一个或多个文件，而不考虑索引中收集的补丁，请运行 git commit [--only|-o] -- $FILE...。

要将补丁块添加到索引，请使用 git add --patch（或简写 -p）。要从索引中删除已收集的文件，请使用 git reset HEAD -- $FILE...。要添加/检查/删除已收集的补丁块，请使用 git add --interactive（-i）。

要查看索引和上次提交之间的差异（即收集到的补丁），请使用 git diff --cached。要查看工作树和索引之间的差异（即未收集的补丁），请只使用 git diff。要查看工作树和上次提交之间的差异（即收集和未收集的补丁），请运行 git diff HEAD。

参见 Git Wiki 中的 WhatIsTheIndex 和 IndexCommandQuickref。

根目录

Git 在运行任何命令之前会切换到根目录（项目顶层目录，其中包含 .git 子目录）。但 Git 会记住切换前所在的当前目录。有些程序会考虑当前目录。例如，git status 显示相对于当前目录的更改和未知文件的路径；git grep 在当前目录下方搜索；git apply 只应用补丁中影响当前目录下方文件的 hunk。

但大多数命令都是从根目录运行并忽略当前目录的。例如，假设您有两个工作树，一个用于 v1 分支，另一个用于 master。如果您想在第二个工作树内的子目录中合并 v1，您必须像在顶层目录中一样编写命令。例如，假设有两个工作树，project-v1 和 project，例如

$ cd project/subdirectory
$ git fetch ../project-v1 v1:v1
$ git merge v1

请注意，在 git fetch ../project-v1 v1:v1 中，路径是 ../project-v1，而不是 ../../project-v1，尽管我们是从子目录而不是根目录运行命令。

ReReRe

Rerere 是一种帮助解决重复合并冲突的机制。重复合并冲突最常见的来源是将主题分支合并到主线中然后删除合并提交；这通常用于测试主题分支并训练 rerere；删除合并提交是为了拥有干净的线性历史，并以仅一个最终合并提交结束主题分支。

Rerere 的工作原理是记住成功提交前后树的状态。这样，如果冲突出现在相同的文件中，rerere 就可以自动解决它们。

Rerere 可以使用 git rerere 命令手动使用，但最常自动使用。在工作树中启用 rerere，使用以下命令

$ git config rerere.enabled true
$ git config rerere.autoupdate true

您不需要全局打开 rerere——您不需要在裸仓库或单分支仓库中使用 rerere；您只需要在经常执行合并和解决合并冲突的仓库中使用 rerere。

请参阅《Pro Git》中的 Rerere。

数据库维护

Git 对象数据库和 .git 下的其他文件/目录需要定期维护和清理。例如，提交编辑会留下未引用的对象（在 Git 术语中称为悬空对象），这些对象应该被修剪以避免在数据库中堆积垃圾。命令 git gc 用于维护。Git 自动将 git gc --auto 作为某些命令的一部分运行，以进行快速维护。建议用户不时运行 git gc --aggressive；git help gc 建议每隔几百个变更集运行一次；对于更密集的项目，应该像每周一次，对于不那么活跃的项目则不那么频繁（每两周或每月一次）。

git gc --aggressive 不仅删除悬空对象，它还将对象数据库重新打包成索引和更优化的包；它还会打包符号引用（分支和标签）。另一种方法是运行 git repack。

Linus Torvalds 有一则著名的 消息，关于 git gc --aggressive 的“愚蠢”。现在这条消息可以安全地忽略了。它已经过时了，从那时起 git gc --aggressive 已经变得好很多了。

对于那些仍然喜欢 git repack 而不是 git gc --aggressive 的人，推荐的参数是 git repack -a -d -f --depth=20 --window=250。有关这些参数影响的解释，请参阅 这个详细实验。

不时运行 git fsck [--strict] 来验证数据库的完整性。git fsck 可能会生成一个悬空对象列表；这不是错误，只是提醒您进行定期维护。

命令行选项和参数

git help cli 建议不要组合短选项/标志。大多数情况下组合是有效的：git commit -av 完美运行，但有时不起作用。例如，git log -p -5 不能组合成 git log -p5。

有些选项带有参数，有些甚至有默认参数。在这种情况下，此类选项的参数必须以粘连方式拼写：-Oarg，切勿 -O arg，因为对于具有默认参数的选项，后者表示“使用选项 -O 的默认值并将 arg 进一步传递给选项解析器”。例如，git grep 有一个选项 -O，它将找到的文件名列表传递给一个程序；-O 的默认程序是分页器（通常是 less），但您可以使用您的编辑器

$ git grep -Ovim  # but not -O vim

顺便说一句，如果 Git 被指示使用 less 作为分页器（即，如果 Git 中根本没有配置分页器，它默认使用 less，或者如果它从 GIT_PAGER 或 PAGER 环境变量中获取 less，或者如果它配置了 git config [--global] core.pager less，或者 less 在命令 git grep -Oless 中使用），git grep 会将 +/$pattern 选项传递给 less，这非常方便。不幸的是，如果分页器不是精确的 less，即使是带有参数的 less（例如 git config [--global] core.pager less -FRSXgimq），git grep 也不会传递模式；幸运的是，git grep -Oless 总是传递模式。

bash/zsh 补全

即使对于那些乐于使用命令行的人来说，手动键入 git rebase --interactive --preserve-merges HEAD~5 也有点困难，而这就是 shell 补全大有帮助的地方。Bash/zsh 带有可编程补全功能，通常会自动安装和启用，所以如果你安装了 bash/zsh 和 git，很可能你已经完成了——只需在命令行中使用它即可。

如果您没有安装必要的组件，请安装并启用 bash_completion 包。如果您想将 Git 补全升级到最新版本，请从 git contrib 下载必要的文件。

Git-for-windows 附带 git-bash，其中已安装并启用了 bash 补全。

bash/zsh 提示符

对于命令行爱好者来说，shell 提示符可以携带大量有用的信息。要将 Git 信息包含在提示符中，请使用 git-prompt.sh。请阅读文件中的详细说明。

在网上搜索“git prompt”以查找其他提示符变体。

SSH 连接共享

SSH 连接共享是 OpenSSH 以及 PuTTY 等衍生产品的一项功能。SSH 连接共享是一种通过建立一个连接并将其重用于连接到同一服务器的所有后续客户端来减少 ssh 客户端启动时间的方法。SSH 连接共享可用于加速大量短 ssh 会话，例如 scp、sftp、rsync，当然还有通过 ssh 的 Git。如果您经常从/向可通过 ssh 访问的远程仓库 fetch/pull/push，建议使用 ssh 连接共享。

要开启 SSH 连接共享，请在您的 ~/.ssh/config 中添加类似以下内容

Host *
ControlMaster auto
ControlPath ~/.ssh/mux-%r@%h:%p
ControlPersist 600

请参阅 OpenSSH wikibook 和 搜索 了解更多信息。

SSH 连接共享可以在 GitHub、GitLab 和 SourceForge 仓库上使用，但请注意 BitBucket 不允许这样做，并在短时间不活动后强制关闭主连接，因此您会看到来自 ssh 的类似错误：“与 bitbucket.org 的连接被远程主机关闭。”