Git 使用
介绍
分布式版本控制系统。
bash
# 列出本地 repo 所有文件
git ls-tree --full-tree -r HEAD
git ls-tree --full-tree -r --name-only HEADbash
git filter-branchbash
# 可以线性化提交历史
git rebase --root- [x] git 如何忽略空行的变化（忽略的话，对同步会不利，不建议）
bash
# 查看文件每行最后一次的提交相关信息
git blame [options] <file>拷贝自水源
bash
# 忽略本地文件系统的优化
git clone --no-local
# 把所有已跟踪的文件的修改添加到暂存区，无需 git add 命令
# 不包括新文件或被删除的文件
git commit -am 'message'
# 修改最后一次提交，不改变提交信息
git commit --amend --no-edit
# 拉取时删除在远程仓库中已被删除的远程跟踪分支的引用
git pull --prune
# 合并两个没有共同历史的 Git 分支
git merge --allow-unrelated-history
# 所有的 reflog 记录将被标记为过期，并且在下一次垃圾回收时被清理
# reflog 引用日志
git reflog expire --expire=now --all
# 遍历所有提交，将每个提交的提交者日期修改为作者日期
# git filter-repo 需单独安装
git filter-repo -f --commit-callback 'commit.committer_date = commit.author_date'相关概念
暂存区（stage）：已经修改、等待后续提交的文件 文件三个类别：未跟踪（Untracked）、已追踪（Tracked）、被忽略（Ignored） HEAD：当前工作区在提交历史中的指针 detached HEAD：HEAD 指向某个历史提交，而不是某个“分支”
bash
# 让当前文件夹变成 git 仓库（创建 .git 文件夹）
git init
# 创建一个新的文件夹并初始化为 git 仓库
git init folder
# 查看某个文件是否被忽略，以及匹配的规则
git check-ignore -v file
# 同时删除本地和版本库中的文件
# 等价于 rm + git add
git rm
# 将一个已暂存的新文件取消暂存
git rm --cached
# 重命名文件
# 等价于 mv + git rm + git add
git mv
.git 结构
WIP…
参考资料
- 可视化 git 学习：GitHub - pcottle/learnGitBranching
- git-flight-rules
- Git/GitHub 基础介绍：lec2.md
GitHub - hongiii/gitNotes_from_Liao: 从廖老师网站上总结的Git笔记，对常见命令进行了总结。
- 以 SQL 的方式查询 repo 的 git 相关内容：Git Query language
使用
工具
- git 操作 TUI 工具：gitui、lazygit
- onefetch：展示本地 Git 仓库的项目详情和代码统计等内容
- gita：管理多个 git repo
- 查看 git repo 的统计信息:GitHub - arzzen/git-quick-stats
基本使用
- 注册 Gitee 或 GitHub 账户
- 配置 Gitee 或 GitHub 的 SSH（
id_rsa.gitee、id_rsa.github、id_rsa.gitlab） - 配置 git（
.gitconfig）
- 新建 repo
bash
git init
git add .
git commit -m "first commit"
# GitHub
git remote add origin [email protected]:username/repo.git
# git remote add origin https://github.com/username/repo.git
# Gitee
git remote add origin [email protected]:username/repo.git
# git remote add origin https://gitee.com/username/repo.git
git push -u origin main- 本地已有 git repo
bash
git remote add origin [email protected]:username/repo.git
git push -u origin main开发使用
bash
# 对于二次开发 repo 人员
git clone [email protected]:username/repo.git
# 切换至新分支 shend_dev
git checkout -b shend_dev
# 修改或者添加本地代码
git add file
git commit -m "message"
# 将本地的 shend_dev 分支上传至 git repo 对应远程分支
git push origin shend_dev
###########################################################
# 对于 repo 所有者，将 shend_dev 合并到主分支
# 将远程的 shend_dev branch pull 到 本地的 shend_dev 分支
git pull origin shend_dev:shend_dev
# 将 shend_dev 合并到主分支
git merge shend_dev
# 或 git rebase shend_dev
###########################################################
# 对于二次开发 repo 人员，开发过程中，主分支有更新
# 切换回主分支
git checkout main
# pull远程主分支
git pull origin main
# 切换至 shend_dev 分支
git checkout shend_dev
# 将main分支合并到 shend_dev 分支，根据自己的 commit 来修改成新的内容
git rebase main
# 以上步骤也可以 git pull origin main:shend_dev
# git pull origin remote-branch-a : local-branch-b
# 中途可能会出现 rebase conflict 手动选择保留哪段代码
# 把 rebas 后并且更新过的代码再 push 到 remote repo；-f 强行
git push -f origin shend_dev特殊文件
.gitconfig
- git 配置文件
- 路径：Linux -
~/.gitconfig；windows -git\etc\gitconfig - 内容示例：
bash
[user]
name = XXX
email = [email protected]
[init]
defaultBranch = main
[credential]
helper = cache --timeout 300000
# optional
# helper = store --file ~/.git-credentials
[core]
quotepath = false
[help]
autocorrect = 1.gitignore
- 忽略文件：写入在
.gitignore文件中的文件/目录会被忽略掉 - 可在 repo 根目录及其子目录分别创建
.gitignore文件 - 常用
.gitignore模板：GitHub - github/gitignore: A collection of useful .gitignore templates
.gitattributes
用于配置 Git 在处理不同类型文件时的行为：定义行结束符（Line Endings）、指定语言统计等（linguist-language）等。
示例 1：.gitattributes- simpy 示例 2：md - .gitattributes - note
bash
# 自动检测文本文件，并执行 LF（Line Feed）规范化操作
* text=auto
*.txt eol=lf
*.jpg binary
*.pdf binary
*.png binary
# 配置特定文件类型的差异（diff）显示策略
# 并非将文件转换为文本文件，只是尝试以文本方式进行显示
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
*.md linguist-documentation=false linguist-detectable=true
*.md linguist-language=Markdown
*.html linguist-detectable=false
*.js linguist-detectable=false
*.css linguist-detectable=false
linguist-documentation=false # 不将文件统计为文档类型
linguist-detectable=true # 开启检测
linguist-language=... # 记为 ... 编程语言
linguist-vendored # 将目录/文件视为外部引入的代码，不计入语言统计中.gitmodules
Git 子模块（submodule）：允许将一个 Git repo 嵌套在另一个 Git repo 中，以便在一个项目中使用其他项目的代码。
.gitmodules 写法及示例：.gitmodules - ZJU-UGCourse
bash
[submodule "submodule"] # 子模块名称
path = submodule # 子模块在 repo 中的相对路径
url = [email protected]:username/submodule.git # 子模块 url
branch = main # 分支名
# 浅克隆
shallow = true
depth = 1添加子模块
bash
git submodule add [email protected]:username/repo.git
# 初始化和更新子模块
git submodule update --init --recursive克隆含子模块的 GitHub repo
bash
# 方式 1
git clone [email protected]:username/repo.git
cd repo
git submodule init # 初始化子模块
git submodule update # 更新子模块
# 以上两个命令可以等效为以下命令
git submodule update --init --recursive
# 方式 2
git clone --recurse-submodules [email protected]:username/repo.git.git-credential
非标准 git 配置文件。
凭证存储
- 默认所有都不缓存。 每一次连接都会询问用户名和密码。
- “cache” 模式会将凭证存放在内存中一段时间。 密码永远不会被存储在磁盘中，并且在 15 分钟后从内存中清除。
- “store” 模式可以接受一个
--file <path>参数，可以自定义存放密码的文件路径（默认是~/.git-credentials）
bash
git config --global credential.helper cache
git config --global credential.helper 'store --file ~/.my-credentials'多账号 ssh 配置
多账号 ssh 配置作用：
- 多账号管理：通过配置 config 文件，可以方便地管理访问多个仓库时使用的不同账号
- 通过 ssh 协议，免密访问、克隆远程仓库，及 git 操作
生成密钥，将
id_rsa.gitee.pub和id_rsa.github.pub文件中的内容添加到 Github 和 Gitee 中的 SSH keys（SSH 公钥）中
bash
ssh-keygen -t rsa -f ~/.ssh/id_rsa.gitee -C "[email protected]"
ssh-keygen -t rsa -f ~/.ssh/id_rsa.github -C "[email protected]"~/.ssh/config文件配置
bash
# GitHub
Host github.com
Port 22
HostName github.com
User git
IdentityFile ~/.ssh/id_rsa.github
# Gitee
Host gitee.com
Port 22
HostName gitee.com
User git
IdentityFile ~/.ssh/id_rsa.gitee
# GitLab
Host gitlab.com
Port 22
HostName gitlab.com
User git
IdentityFile ~/.ssh/id_rsa.gitlab- 测试
bash
ssh -T [email protected]
ssh -T [email protected]
ssh -T [email protected]- 若返回信息，则配置成功
text
Hi XXX! You've successfully authenticated, but GitHub does not provide shell access.
Hi XXX! You've successfully authenticated, but GITEE.COM does not provide shell access.
Welcome to GitLab, XXX!- 注意事项：
~/.ssh/config文件出现Bad owner or permissions错误的解决办法：文件权限问题，设置 config 文件权限为600- 超算平台中的登陆节点禁止对外的 ssh，无法使用 git 交互环境，建议在本地或者实验室工作站（manager 和 master）使用；超算平台进行以上设置会出现以下报错：
bash
ssh: connect to host github.com port 22: Network is unreachable将 repo 的 remote origin 由 https 改为 ssh 或 token 形式
之后进行 push、pull 等操作时，将默认通过 SSH 协议，并使用 SSH keys 进行身份验证，不需再输入用户名和密码
在该 repo 目录中的
.git/config文件找到[remote "origin"]选项，将 URL 后的 https 地址改成 ssh 形式或带 token 的地址
bash
# https 形式
url = https://github.com/user/repo.git
# ssh 形式
url = [email protected]:user/repo.git
url = [email protected]:user/repo.git
# https + token 形式
url = https://user:[email protected]/user/repo.git
url = https://user:[email protected]/user/repo.gitGitHub Token
GitHub 从 2021 年开始不再支持输入账号和密码的形式进行验证，密码改为 Token（Gitee 验证仍是账号和密码）。
具体设置：Settings - Developer settings - Personal access tokens - Tokens(classic)
为 repo 创建 gh-pages 分支并 deploy
一般通过第三方的 Github Actions repo
- GitHub Marketplace · Actions to improve your workflow · GitHub
- GitHub - peaceiris/actions-gh-pages: GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.
Gitee 与 GitHub、GitLab 之间互相同步
- Gitee 可以直接从 GitHub 和 GitLab 中导入 repo
- 参考：仓库镜像管理（Gitee<->Github 双向同步） - Gitee 产品文档、Gitlab、Github、Gitee之间的代码同步_gitea 和gitee能同步吗_李·逍遥的博客-CSDN博客
Git LFS
Git LFS(Git Large File Storage) ：GitHub 推出的大文件存储服务，让 git 只保存二进制文件的 hash，而二进制文件将会存在 Git LFS 服务器中（Gitee 只对付费企业开放；GitHub 的免费存储空间为 1G，限带宽 1GB/月，超过需升级）。以减小 Git 仓库体积，加快仓库的克隆和拉取。
bash
# 安装
sudo apt-get install git-lfs # Ubuntu
brew install git-lfs # macOS
git lfs install # 初始化
# 跟踪大文件 会生成 .gitattributes 文件
git lfs track "*.pdf"
git add .gitattributes
git commit -m "add .gitattributes"
# 查看当前已跟踪的 Git LFS File 类型
git lfs track
# 拉取 LFS 文件
git lfs pull
git lfs clone repo # 克隆
# 列出当前已通过 LFS 跟踪的所有文件
git lfs ls-files
# 取消跟踪并删除
git lfs untrack "*.pdf"
git rm --cached "*.pdf"
# 将历史文件迁移到 LFS
git lfs migrate import --include="*.dmg" --everything
git push --force # 强制推送git-filter-repo
- Git 历史重写工具
- 运行
git filter-repo后，会改变.git/config文件，只保留[core]参数信息，需重新添加远程 repo url 并强制推送
bash
# 安装
brew install git-filter-repo # macOS
pip install -U git-filter-repo # pip
# 使用
--dry-run # 模拟运行
# 删除文件（及包含该文件的 commit 历史）
git filter-repo --path-glob '*.jpg' --invert-paths
# 重命名文件或目录
git filter-repo --path old/path --to-path new/path
# 替换作者信息
git filter-repo --name-callback 'return name.replace(b"Old Name", b"New Name")'
# 删除大文件
git filter-repo --strip-blobs-bigger-than 10M
# 提取子目录
git filter-repo --subdirectory-filter path/to/directory
# 强制推送至远程 repo
git push -f origin main常用命令
clone
- 提交数量增加，提交过大文件，会使得
.git/object体积增加，可通过--depth选项来进行浅克隆
bash
git clone --depth 1 <url> # 只 clone 最新提交
git clone -b <branch1> -b <branch2> <url> # clone 多个分支config
bash
# 列出 repo 配置
git config --list
# 列出全局配置
git config --global --list
# 全局设置
git config --global user.name "username"
git config --global user.email "[email protected]"
# 取消全局配置
git config --global --unset user.name
git config --global --unset user.email
# 取消代理
git config --global --unset http.proxy
git config --global --unset https.proxy
# git 命令输出里加上颜色
git config --global color.ui 1
# 配置默认编辑器
git config --global core.editor "vim"
# 忽略文件的权限变化
git config core.fileMode false
# 解决 git status 中文乱码 问题
git config --global core.quotepath false
# 开启自动纠错功能
git config --global help.autocorrect 1
# 列出配置即对应配置文件路径
git config --list --show-originadd
bash
git add file
git add --patch # 或 -p；对于所有的修改依次进行添加确认
git add -i # 交互式commit
bash
# 根据当前时间进行 commit
git commit -m "$(date '+%Y-%m-%d %H:%M:%S')"
# 修改 commit 信息
git commit --amend --no-edit -m 'xxx'
# 创建没有任何改动的提交
git commit -m 'empty' --allow-emptypush
bash
git pushpull
bash
git pull
git pull --rebasebranch
bash
git branch # 查看本地分支
git show-branch # 更详细
git branch -r # 查看远程分支
git branch -a # 查看所有分支（本地 + 远程）
git brach -u <upstream> # 设置本地分支与远程分支之间的追踪关系
git brach -u origin/main # 示例；之后的 pull push 无需再指定 origin/main
git branch -m <NewBranchName> # 重命名为新分支
# 删除本地分支
git branch -d <BranchName> # 删除前会提醒是否进行分支合并
git branch -D <BranchName> # 强制
# 列出 repo 所有分支信息（分支名称 + 关联的远程分支 + commit 信息）
git branch -vv
# 示例
* master 8b700ba [origin/master] vault backup: 2024-04-01 19:11:49checkout
bash
git checkout <BranchName> # 切换分支
git checkout -b <BranchName> # 创建并切换新分支
git checkout - # 迅速切换到上一个分支
# 关联分支
git checkout -b <BranchName> origin/<RemoteBranchName>remote
bash
git remote show origin # 查看远程 repo 所有分支
git ls-remote origin # 列出远程仓库的引用（分支和标签）
# 使本地的跟踪分支列表与远程保持一致，删除远程分支已经不存在而本地还保留的跟踪记录
git remote prune origin
git remote prune origin --dry-run # 不实际删除
#
git remote rm originstatus
bash
git status
git status --short --branchreset
bash
# 撤销整个暂存区的 add 操作
git reset
# 撤回最后一次 commit 保留代码修改
git reset HEAD~
# --hard 不保留代码修改
git reset HEAD~ --hard
# 撤销指定文件 add 操作
git reset <file>
# 退回到指定的 commit hash 值所在版本
git reset --hard <commit_hash>fetch
bash
# 从远程仓库（所有分支）获取最新版本到本地仓库，但不会自动 merge 或 rebase 到当前分支
git fetch originmerge
bash
# 合并时使用 vim 编辑器
GIT_EDITOR=vim git merge tmptag
bash
# 版本号命名一般规范：v主版本号.次版本号.修订号[-预发布版本号]
# 修订号：兼容修改，修正不正确的行为
# 次版本号：添加新功能，但是保持兼容
# 主版本号：不兼容的 API 修改；为 0 时表示还在开发阶段，不保证稳定性
# 示例：v1.0.0 v1.0.0-beta
# 查看标签
git tag # 本地
git ls-remote --tags origin # 远程
git tag -l # 列出标签
git tag -ln # 列出标签及其注释
git show v1.0.0 # 查看具体标签信息
# 新建标签
git tag v1.0.0
git tag -a v1.0.0 -m 'content' # 带注释
# push 标签
git push origin v1.0.0
git push origin --tags # 所有标签
# 删除标签
git tag -d v0.0.1 # 本地
git push origin :refs/tags/v0.0.1 # 远程
git push origin --delete $(git tag -l) # 所有远程标签
git pull --all # pull 远程所有内容包括标签log
日志 log
bash
git log # 查看提交日志
git reflog # 查看所有分支的所有操作记录
# 较为简洁美观的 git log 输出样式
git log --oneline --graph --all
git log --oneline --graph --stat
# 源于 zsh git alias
git log --graph --pretty="%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%ar) %C(bold blue)<%an>%Creset" --stat
-p # --patch；显示详细修改内容
--graph # 显示分支结构
--stat #
--oneline # 一行显示；commit id 8 个字符
--pretty=oneline # 一行显示；完整 commit id
--pretty=%B # 只显示 commit message
--pretty=%H # 只显示 commit hash
-n N / HEAD~N # 显示最新的前 N 条提交记录
--grep=pattern # 查看给定 pattern 的提交记录diff
bash
# 比较工作区和暂存区
git diff
# 比较工作区和分支
git diff <BranchName>
# 比较两个分支
git diff <BranchName1> <BranchName2>
# 查看工作区文件改动统计（个数，增加、删除行数）
git diff --stat
git diff --stat file
# 查看两次提交之间的差异
git diff <commit_id_1> <commit_id_2> --stat
# 查看特定提交的所有改动统计
git show <commit_id> --stat
git diff-tree <commit_id> --stat
# 查看暂存区文件的改动统计
# staged cached 同义词
# --word-diff 忽略空行
git diff --staged --stat
git diff --cached --statstash
- 用于临时保存暂存区的未提交更改，返回工作区。
- 暂存项（stashes）遵循栈结构，即最近暂存的更改会被放置在栈的顶部（索引为 0）；stash 编号为
stash@{N}，N=0 表示栈顶，即最近一次的暂存。
bash
git stash # 将当前修改暂存到 stash 栈中
git stash -u # 包括新增 untracked 文件
git stash push -- file # 指定单个文件
git stash save 'message' # 添加备注
# 列出所有 stash
git stash list
# 恢复 stash 中的最近一次暂存，并从 stash 栈中删除
git stash pop
# 恢复 stash 中的最近一次暂存，但不从 stash 栈中删除
git stash apply
git stash show -p # 查看 stash 修改内容
# 恢复特定 stash
git stash apply stash@{n}
# 删除特定 stash
git stash drop stash@{n}
# 清空 stash
git stash clear
# 从 stash 中创建一个新的分支
git stash branch <branch>rm
bash
# 从工作区批量去除已删除文件
git rm $(git ls-files -d)
# 删除 push 到远程 repo 的文件/目录
git rm --cached file
git rm -r --cached foldergit 命令自定义别名
- git-命令自定义别名
- 查看历史 - Git 重学指南
- GitHub - GitAlias/gitalias: Git alias commands for faster easier version control
bash
# 方式 1 命令行终端设置
git config --global alias.p 'push'
# 方式 2 直接在 ~/.gitconfig 添加
[alias]
p = push- oh-my-zsh 定义了 许多 git 命令的 alias：
alias | grep 'git subcommand'
其他用法
提交空文件夹：在空文件夹中创建
.gitkeep文件删除本地及对应的远程分支
bash
# 删除本地分支
git branch -D <local-branch>
# 删除远程分支
git push origin :<remote-branch>
git push origin --delete <remote-branch>
# 删除远程分支已经不存在而本地还保留的跟踪记录
git remote prune origin- 查看 repo commit 总次数
bash
# 查看初始提交到当前 HEAD 提交的总提交次数
git rev-list --count HEAD
# 查看所有分支的总提交次数
git rev-list --all --count
# 按作者查看提交次数
git shortlog -s -n
# 统计当天的提交数
# 方式 1
git rev-list --count --since=@{0:00} --before=@{23:59:59} HEAD
# 方式 2
git log --since='midnight' --until='now' --pretty=oneline | wc -l- push 到多个远程 repo：git-tips#文件推向3个git库
- 只能从
origin里的一个 repo url pull 代码，默认为添加到origin的第一个地址；若需调整 repo url 顺序，可在./.git/config文件中直接调整 - 可用此方法替代 Gitee 与 GitHub 之间互相同步的设置
- 只能从
bash
# 添加远程 repo url
git remote add origin url
git remote set-url --add origin url
# 删除远程 repo url
git remote set-url --delete origin url- git clone 部分内容：如何使用 Git 只克隆部分文件 | 猎人杂货铺
git sparse-checkout- 可实现只克隆或检出指定文件夹，不下载所有内容--filter=blob:none- 只获取元数据，不下载原始数据部分
bash
# 方式 1 速度更快
git clone --filter=blob:none --sparse <repo>
git sparse-checkout set <file> <folder>
# 方式 2
git clone --filter=blob:none --no-checkout <repo>
git checkout origin/main -- <file> <folder>- 下载单个文件：打开文件，点击 “Raw”，用
wget下载，示例：
bash
# gitee
wget https://gitee.com/Devkings/oh_my_zsh_install/raw/master/install.sh -O install.sh
# github
wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O install.sh
# gist
wget https://gist.githubusercontent.com/user/GIST_ID/raw/filename -O filename- GitHub 加速下载：安装 GitHub 增强插件：Github 增强 - 高速下载
- 规范式 commit
gitmoji-cli：git commit 时使用 emoji
- 其他
bash
# 查看两星期内的改动
git whatchanged --since='2 weeks ago'
# 只保留最新的一次提交以减小 repo 体积
git checkout --orphan <NewBranchName> <last-commit-hash> # 基于最后的 commit 创建新分支
git commit -m 'new init' # 提交
git branch -D main # 删除分支
git branch -m main # 新分支重命名为 main 主分支
git push origin main --force # 强制 push
# 列出所有提交对象
git rev-list --objects --all
# 列出大文件
git rev-list --objects --all | grep "$(git verify-pack -v .git/objects/pack/*.idx | sort -k 3 -n | tail -5 | awk '{print$1}')"- 创建 Releases：Create a new release - Choose a tag，之后填写相关信息，必要时上传附件
- 新建空分支：GitHub 中的 gh-pages 分支为特殊分支，可与主分支无关联（push 时会自动启用 Github Actions），其他命名的分支暂无法实现与主分支无关联；git - Create empty branch on GitHub - Stack Overflow
bash
git switch --orphan <new branch>
git commit --allow-empty -m "init"
git push -u origin <new branch>相关问题
- github 和 gitee 中的 md 文档无法渲染
\begin{}等 复杂 LaTeX 公式命令 - github 可以渲染 Front-Matter，gitee 和 typora 暂不行，但会将其包裹起来
坑：ssh: connect to host github.com port 22: Connection refused - 知乎