# Flight rules for Git 🌍 *[English](README.md) ∙ [Español](README_es.md) ∙ [РусскОй](README_ru.md) ∙ [简䜓䞭文](README_zh-CN.md)∙ [한국얎](README_kr.md) ∙ [Tiếng Việt](README_vi.md) ∙ [Français](README_fr.md)* #### What are "flight rules"? A guide for astronauts (now, programmers using Git) about what to do when things go wrong. > *Flight Rules* are the hard-earned body of knowledge recorded in manuals that list, step-by-step, what to do if X occurs, and why. Essentially, they are extremely detailed, scenario-specific standard operating procedures. [...] > NASA has been capturing our missteps, disasters and solutions since the early 1960s, when Mercury-era ground teams first started gathering "lessons learned" into a compendium that now lists thousands of problematic situations, from engine failure to busted hatch handles to computer glitches, and their solutions. — Chris Hadfield, *An Astronaut's Guide to Life*. #### Conventions for this document For clarity's sake all examples in this document use a customized bash prompt in order to indicate the current branch and whether or not there are staged changes. The branch is enclosed in parentheses, and a `*` next to the branch name indicates staged changes. All commands should work for at least git version 2.13.0. See the [git website](https://www.git-scm.com/) to update your local git version. [![Join the chat at https://gitter.im/k88hudson/git-flight-rules](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/k88hudson/git-flight-rules?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - [Repositories](#repositories) - [I want to start a local repository](#i-want-to-start-a-local-repository) - [I want to clone a remote repository](#i-want-to-clone-a-remote-repository) - [I set the wrong remote repository](#i-set-the-wrong-remote-repository) - [I want to add code to someone else's repository](#i-want-to-add-code-to-someone-elses-repository) - [Suggesting code via pull requests](#suggesting-code-via-pull-requests) - [I need to update my fork with latest updates from the original repository](#i-need-to-update-my-fork-with-latest-updates-from-the-original-repository) - [Editing Commits](#editing-commits) - [What did I just commit?](#what-did-i-just-commit) - [I wrote the wrong thing in a commit message](#i-wrote-the-wrong-thing-in-a-commit-message) - [I committed with the wrong name and email configured](#i-committed-with-the-wrong-name-and-email-configured) - [I want to remove a file from the previous commit](#i-want-to-remove-a-file-from-the-previous-commit) - [I want to delete or remove my last commit](#i-want-to-delete-or-remove-my-last-commit) - [Delete/remove arbitrary commit](#deleteremove-arbitrary-commit) - [I tried to push my amended commit to a remote, but I got an error message](#i-tried-to-push-my-amended-commit-to-a-remote-but-i-got-an-error-message) - [I accidentally did a hard reset, and I want my changes back](#i-accidentally-did-a-hard-reset-and-i-want-my-changes-back) - [I accidentally committed and pushed a merge](#i-accidentally-committed-and-pushed-a-merge) - [I accidentally committed and pushed files containing sensitive data](#i-accidentally-committed-and-pushed-files-containing-sensitive-data) - [I want to remove a large file from ever existing in repo history](#i-want-to-remove-a-large-file-from-ever-existing-in-repo-history) - [Recommended Technique: Use third-party bfg](#recommended-technique-use-third-party-bfg) - [Built-in Technique: Use git-filter-branch](#built-in-technique-use-git-filter-branch) - [Final Step: Pushing your changed repo history](#final-step-pushing-your-changed-repo-history) - [I need to change the content of a commit which is not my last](#i-need-to-change-the-content-of-a-commit-which-is-not-my-last) - [Staging](#staging) - [I want to stage all tracked files and leave untracked files](#i-want-to-stage-all-tracked-files-and-leave-untracked-files) - [To stage part of tracked files](#to-stage-part-of-tracked-files) - [I need to add staged changes to the previous commit](#i-need-to-add-staged-changes-to-the-previous-commit) - [I want to stage part of a new file, but not the whole file](#i-want-to-stage-part-of-a-new-file-but-not-the-whole-file) - [I want to add changes in one file to two different commits](#i-want-to-add-changes-in-one-file-to-two-different-commits) - [I staged too many edits, and I want to break them out into a separate commit](#i-staged-too-many-edits-and-i-want-to-break-them-out-into-a-separate-commit) - [I want to stage my unstaged edits, and unstage my staged edits](#i-want-to-stage-my-unstaged-edits-and-unstage-my-staged-edits) - [Unstaged Edits](#unstaged-edits) - [I want to move my unstaged edits to a new branch](#i-want-to-move-my-unstaged-edits-to-a-new-branch) - [I want to move my unstaged edits to a different, existing branch](#i-want-to-move-my-unstaged-edits-to-a-different-existing-branch) - [I want to discard my local uncommitted changes (staged and unstaged)](#i-want-to-discard-my-local-uncommitted-changes-staged-and-unstaged) - [I want to discard specific unstaged changes](#i-want-to-discard-specific-unstaged-changes) - [I want to discard specific unstaged files](#i-want-to-discard-specific-unstaged-files) - [I want to discard only my unstaged local changes](#i-want-to-discard-only-my-unstaged-local-changes) - [I want to discard all of my untracked files](#i-want-to-discard-all-of-my-untracked-files) - [I want to unstage a specific staged file](#i-want-to-unstage-a-specific-staged-file) - [Branches](#branches) - [I want to list all branches](#i-want-to-list-all-branches) - [Create a branch from a commit](#create-a-branch-from-a-commit) - [I pulled from/into the wrong branch](#i-pulled-frominto-the-wrong-branch) - [I want to discard local commits so my branch is the same as one on the server](#i-want-to-discard-local-commits-so-my-branch-is-the-same-as-one-on-the-server) - [I committed to master instead of a new branch](#i-committed-to-master-instead-of-a-new-branch) - [I want to keep the whole file from another ref-ish](#i-want-to-keep-the-whole-file-from-another-ref-ish) - [I made several commits on a single branch that should be on different branches](#i-made-several-commits-on-a-single-branch-that-should-be-on-different-branches) - [I want to delete local branches that were deleted upstream](#i-want-to-delete-local-branches-that-were-deleted-upstream) - [I accidentally deleted my branch](#i-accidentally-deleted-my-branch) - [I want to delete a branch](#i-want-to-delete-a-branch) - [I want to delete multiple branches](#i-want-to-delete-multiple-branches) - [I want to rename a branch](#i-want-to-rename-a-branch) - [I want to checkout to a remote branch that someone else is working on](#i-want-to-checkout-to-a-remote-branch-that-someone-else-is-working-on) - [I want to create a new remote branch from current local one](#i-want-to-create-a-new-remote-branch-from-current-local-one) - [I want to set a remote branch as the upstream for a local branch](#i-want-to-set-a-remote-branch-as-the-upstream-for-a-local-branch) - [I want to set my HEAD to track the default remote branch](#i-want-to-set-my-head-to-track-the-default-remote-branch) - [I made changes on the wrong branch](#i-made-changes-on-the-wrong-branch) - [Rebasing and Merging](#rebasing-and-merging) - [I want to undo rebase/merge](#i-want-to-undo-rebasemerge) - [I rebased, but I don't want to force push](#i-rebased-but-i-dont-want-to-force-push) - [I need to combine commits](#i-need-to-combine-commits) - [Safe merging strategy](#safe-merging-strategy) - [I need to merge a branch into a single commit](#i-need-to-merge-a-branch-into-a-single-commit) - [I want to combine only unpushed commits](#i-want-to-combine-only-unpushed-commits) - [I need to abort the merge](#i-need-to-abort-the-merge) - [I need to update the parent commit of my branch](#i-need-to-update-the-parent-commit-of-my-branch) - [Check if all commits on a branch are merged](#check-if-all-commits-on-a-branch-are-merged) - [Possible issues with interactive rebases](#possible-issues-with-interactive-rebases) - [The rebase editing screen says 'noop'](#the-rebase-editing-screen-says-noop) - [There were conflicts](#there-were-conflicts) - [Stash](#stash) - [Stash all edits](#stash-all-edits) - [Stash specific files](#stash-specific-files) - [Stash with message](#stash-with-message) - [Apply a specific stash from list](#apply-a-specific-stash-from-list) - [Stash while keeping unstaged edits](#stash-while-keeping-unstaged-edits) - [Finding](#finding) - [I want to find a string in any commit](#i-want-to-find-a-string-in-any-commit) - [I want to find by author/committer](#i-want-to-find-by-authorcommitter) - [I want to list commits containing specific files](#i-want-to-list-commits-containing-specific-files) - [I want to view the commit history for a specific function](#i-want-to-view-the-commit-history-for-a-specific-function) - [Find a tag where a commit is referenced](#find-a-tag-where-a-commit-is-referenced) - [Submodules](#submodules) - [Clone all submodules](#clone-all-submodules) - [Remove a submodule](#remove-a-submodule) - [Miscellaneous Objects](#miscellaneous-objects) - [Copy a folder or file from one branch to another](#copy-a-folder-or-file-from-one-branch-to-another) - [Restore a deleted file](#restore-a-deleted-file) - [Delete tag](#delete-tag) - [Recover a deleted tag](#recover-a-deleted-tag) - [Deleted Patch](#deleted-patch) - [Exporting a repository as a Zip file](#exporting-a-repository-as-a-zip-file) - [Push a branch and a tag that have the same name](#push-a-branch-and-a-tag-that-have-the-same-name) - [Tracking Files](#tracking-files) - [I want to change a file name's capitalization, without changing the contents of the file](#i-want-to-change-a-file-names-capitalization-without-changing-the-contents-of-the-file) - [I want to overwrite local files when doing a git pull](#i-want-to-overwrite-local-files-when-doing-a-git-pull) - [I want to remove a file from Git but keep the file](#i-want-to-remove-a-file-from-git-but-keep-the-file) - [I want to revert a file to a specific revision](#i-want-to-revert-a-file-to-a-specific-revision) - [I want to list changes of a specific file between commits or branches](#i-want-to-list-changes-of-a-specific-file-between-commits-or-branches) - [I want Git to ignore changes to a specific file](#i-want-git-to-ignore-changes-to-a-specific-file) - [Debugging with Git](#debugging-with-git) - [Configuration](#configuration) - [I want to add aliases for some Git commands](#i-want-to-add-aliases-for-some-git-commands) - [I want to add an empty directory to my repository](#i-want-to-add-an-empty-directory-to-my-repository) - [I want to cache a username and password for a repository](#i-want-to-cache-a-username-and-password-for-a-repository) - [I want to make Git ignore permissions and filemode changes](#i-want-to-make-git-ignore-permissions-and-filemode-changes) - [I want to set a global user](#i-want-to-set-a-global-user) - [I want to add command line coloring for Git](#i-want-to-add-command-line-coloring-for-git) - [I've no idea what I did wrong](#ive-no-idea-what-i-did-wrong) - [Git Shortcuts](#git-shortcuts) - [Git Bash](#git-bash) - [PowerShell on Windows](#powershell-on-windows) - [Other Resources](#other-resources) - [Books](#books) - [Tutorials](#tutorials) - [Scripts and Tools](#scripts-and-tools) - [GUI Clients](#gui-clients) ## リポゞトリ ### ロヌカルリポゞトリを初期化したい 既存のディレクトリを Git リポゞトリずしお初期化するには、次を実行したす ```sh (my-folder) $ git init ``` ### リモヌトリポゞトリをクロヌンしたい リモヌトリポゞトリをクロヌンコピヌしたいずきは、リポゞトリの URL をコピヌし、次を実行したす ```sh $ git clone [url] ``` するず、リモヌトリポゞトリず同名のフォルダにリポゞトリの内容が保存されたす。 リモヌトリポゞトリのあるサヌバに接続できる必芁がありたす。倧抵の堎合むンタヌネット接続があれば倧䞈倫です。 リモヌトリポゞトリず異なる名前のフォルダにクロヌンしたいずきは、次のようにしたす ```sh $ git clone [url] name-of-new-folder ``` ### 間違ったリモヌトリポゞトリを蚭定しおしたった 問題はいく぀かの堎合に分けられたす。 間違ったリポゞトリをクロヌンしおしたったずきは、`git clone` で䜜ったディレクトリを削陀しお、正しいリポゞトリをクロヌンし盎せばよいです。 間違ったリポゞトリを既存のロヌカルリポゞトリの origin に蚭定しおしたったずきは、次のように origin の URL を倉曎したしょう ```sh $ git remote set-url origin [url of the actual repo] ``` ほかの問題の堎合は、[この StackOverflow トピック](https://stackoverflow.com/questions/2432764/how-to-change-the-uri-url-for-a-remote-git-repository#2432799)を参照しおみおください。 ### 他の人のリポゞトリにコヌドを曞き加えたい Git では、アクセス暩がないず他の人のリポゞトリに曞き蟌むこずはできたせん。GitHub は Git リポゞトリのホスティングサヌビスであっお Git 自䜓ずは異なるものですが、GitHub でもやはり同様です。しかし、パッチによっおコヌドを提案するこずができたす。GitHub ならフォヌクずプルリク゚ストの機胜がこれにあたりたす。 たずはフォヌクに぀いお説明したしょう。フォヌクはリポゞトリのコピヌです。Git 自䜓の機胜ではないものの、GitHub, BitBucket, GitLab やその他のホスティングサヌビスにはこの機胜があり、各サヌビスの UI を通しお実行できたす。 #### プルリク゚ストでコヌドを提案するには リポゞトリをフォヌクしたら、ロヌカルマシンにクロヌンしお線集したしょう。ちょっずした線集なら GitHub 䞊でもできるでしょうが、この文曞は GitHub フラむトルヌルではないので、ロヌカルで線集する方法を説明したす。 ```sh # ssh を䜿う堎合 $ git clone git@github.com:k88hudson/git-flight-rules.git # https を䜿う堎合 $ git clone https://github.com/k88hudson/git-flight-rules.git ``` できたディレクトリに `cd` で移動し、`git remote` を実行しおください。リモヌトのリストが衚瀺されるはずです。 ただ、おそらく衚瀺されるのは `k88hudson/git-flight-rules` を参照する `origin` だけなので、自分がフォヌクしお䜜った方のリモヌトも甚意する必芁がありたす。 Git では、自分自身のリポゞトリのリモヌトには `origin`、フォヌクした元のリポゞトリは `upstream` ず名付けるのが䞀般的です。これにならっお、たず、リモヌト `origin` の名前を `upstream` に倉曎したしょう ```sh $ git remote rename origin upstream ``` 実は `git remote set-url` でも同じこずができたすが、時間ず手間が䜙蚈にかかりたす。 次に、自分のプロゞェクトを参照する新しいリモヌトを䜜成したす。 ```sh $ git remote add origin git@github.com:YourName/git-flight-rules.git ``` この時点でリモヌトは二぀です - `origin` は自分のリポゞトリを参照しおいたす。 - `upstream` は元のリポゞトリを参照しおいたす。 `origin` は読み取り・曞き蟌みの䞡方ができ、`upstream` は読み取り専甚です。 線集が枈んだら、線集内容を通垞はブランチ内からリモヌト `origin` にプッシュしたしょう。 ブランチ内にいる堎合、次のように `--set-upstream` を䜿うず、次回から同じブランチからプッシュする際にリモヌトを指定せずに枈みたす ```sh $ (feature/my-feature) git push --set-upstream origin feature/my-feature ``` Git で CLI からプルリク゚ストを送る方法はありたせん[hub](http://github.com/github/hub) のようなツヌルを䜿えば別ですが。 プルリク゚ストを送りたいずきは、GitHubあるいは他のホスティングサヌビス䞊でプルリク゚ストを䜜成しおください。元のリポゞトリずフォヌクしたリポゞトリを関連付けるのはホスティングサヌビスが自動的にしおくれたす。 プルリク゚ストの埌、コヌドレビュヌのフィヌドバックに察応するのを忘れないようにしたしょう。 #### フォヌクしたリポゞトリを、元のリポゞトリの最新版に合わせお曎新したい そのうち `upstream` リポゞトリが曎新され、自分の `origin` にプルしたくなるかもしれたせん。 自分だけでなく他の人も共同䜜業しおいるこずを忘れないようにしおください。 自分のフィヌチャヌブランチにいお、これを元のリポゞトリに合わせお曎新したい堎合を想定したす。 元のプロゞェクトを参照するリモヌトは蚭定しおありたすか ただなら今やっおしたいたしょう。通垞はリモヌトの名前に `upstream` を䜿いたす ```sh $ (master) git remote add upstream # $ (master) git remote add upstream git@github.com:k88hudson/git-flight-rules.git ``` これで `upstream` から最新版をフェッチできるようになりたした。 ```sh $ (master) git fetch upstream $ (master) git merge upstream/master # コマンド䞀぀でもできる $ (master) git pull upstream master ``` ## コミットの線集 ### 䜕をコミットしたかわからなくなった 䜕も考えず `git commit -a` で線集をコミットしおしたい、その内容がわからないずしたす。 珟圚の HEAD の最新のコミット内容は次のように衚瀺できたす ```sh (master)$ git show ``` あるいは ```sh $ git log -n1 -p ``` 特定のコミットにおけるファむルの䞭身を芋たいずきは次のようにしたす`` は芋たいコミット ```sh $ git show :filename ``` ### コミットメッセヌゞに間違った内容を曞いおしたった コミットメッセヌゞに間違った内容を曞いおしたったずしたす。 コミットがただプッシュされおいない堎合は、次のようにしお線集内容は倉えずにコミットメッセヌゞを線集できたす ```sh $ git commit --amend --only ``` デフォルトのテキスト゚ディタが開き、コミットメッセヌゞを線集できたす。これらを䞀぀のコマンドでいっぺんにやるこずもできたす ```sh $ git commit --amend --only -m 'xxxxxxx' ``` 既にコミットをプッシュしおしたった堎合、コミットを修正しお匷制プッシュするこずはできたすが、おすすめしたせん。 ### 間違った名前・メヌルアドレスの蚭定でコミットしおしたった コミットが䞀぀だけなら、次のように修正したす。 ```sh $ git commit --amend --no-edit --author "New Authorname " ``` あるいは、名前ずメヌルアドレスを `git config --global author.(name|email)` で正しく蚭定しおから、次のようにしたす ```sh $ git commit --amend --reset-author --no-edit ``` 履歎すべおに぀いお倉曎したい堎合は、`git filter-branch` の man ペヌゞを参照しおください。 ### 盎前のコミットからファむルを削陀したい 盎前のコミットから特定のファむルの線集内容を削陀するには次のようにしたす。 ```sh $ git checkout HEAD^ myfile $ git add myfile $ git commit --amend --no-edit ``` 盎前のコミットで新たに远加したファむルをGit のみから削陀したいずきは次の通りです。 ```sh $ git rm --cached myfile $ git commit --amend --no-edit ``` このコマンドは、パッチに䞍芁なファむルをコミットしおしたい、匷制プッシュでリモヌトのパッチを曎新したいずきに特に䟿利です。 オプション `--no-edit` は既にあるコミットメッセヌゞを倉曎しないようにするためのものです。 ### 盎前のコミットを削陀したい 既にプッシュしたコミットを削陀するには次のようにしたす。 ただし、線集履歎が䞍可逆的に倉曎され、リポゞトリから倉曎内容をプルしおしたった他の人の線集履歎は滅茶苊茶になりたす。 芁するに、よくわからない堎合は絶察にしないでください。 ```sh $ git reset HEAD^ --hard $ git push --force-with-lease [remote] [branch] ``` ただコミットをプッシュしおいない堎合は、次のようにしおステヌゞされた線集はそのたたで盎前のコミットをする前の状態に Git をリセットできたす。 ``` (my-branch*)$ git reset --soft HEAD@{1} ``` これはプッシュしおいない堎合にのみ有効な方法です。 プッシュしおしたった堎合、本圓に安党な方法は `git revert SHAofBadCommit` だけです。 このコマンドは、盎前のコミットを取り消すようなコミットを新たに䜜成したす。 プッシュしたブランチがリベヌスに぀いお安党である堎合぀たり、他の開発者がプルするこずを想定しおいない堎合は、`git push --force-with-lease` を䜿っおも倧䞈倫です。 ### 任意のコミットを削陀したい 䞊で述べたのず同様に、やむを埗ない堎合以倖絶察に行わないでください。 ```sh $ git rebase --onto SHA1_OF_BAD_COMMIT^ SHA1_OF_BAD_COMMIT $ git push --force-with-lease [remote] [branch] ``` あるいは [察話的 rebase](#interactive-rebase) で削陀したいコミットに察応する行を遞択しお削陀したす。 ### 修正したコミットをリモヌトにプッシュしようずしたら、゚ラヌメッセヌゞが出た ```sh To https://github.com/yourusername/repo.git ! [rejected] mybranch -> mybranch (non-fast-forward) error: failed to push some refs to 'https://github.com/tanay1337/webmaker.org.git' hint: Updates were rejected because the tip of your current branch is behind hint: its remote counterpart. Integrate the remote changes (e.g. hint: 'git pull ...') before pushing again. hint: See the 'Note about fast-forwards' in 'git push --help' for details. ``` amend による修正は、rebase ず同様に埌述、**叀いコミットを新たなコミットで眮き換えたす**。それゆえ、修正前のコミットを既にリモヌトにプッシュしおしたっおいる堎合は、匷制プッシュ (`--force-with-lease`) しなければいけたせん。 匷制プッシュには现心の泚意が必芁です。*必ず*ブランチを指定するように ```sh (my-branch)$ git push origin mybranch --force-with-lease ``` 䞀般論ずしお、**匷制プッシュは避けたしょう**。修正したコミットを匷制プッシュするよりは、新たなコミットを䜜っおプッシュするのがベストです。 匷制プッシュは、察象のブランチやその子ブランチで䜜業した他の開発者の゜ヌス履歎に霟霬をきたしおしたいたす。 誰かが同じブランチで䜜業しおいお、匷制プッシュがその人の線集を䞊曞きしおしたう堎合には、`--force-with-lease` も倱敗したす。 他の誰も同じブランチで䜜業しおいないこずが*絶察に*確実な堎合、あるいはブランチの䞀郚を*無条件で*曎新したい堎合は `--force` (`-f`) で行うこずができたすが、これは原則的に避けるべきです。 ### 間違えお hard reset しおしたい、元に戻したい 間違えお `git reset --hard` をしおしたった堎合でも、倧抵はコミットを埩元できたす。Git は数日間のログを党お残しおくれおいるからです。 泚意これは䜜業がバックアップされおいる堎合、぀たりコミットかスタッシュされおいる堎合のみです。`git reset --hard` はコミットされおいない倉曎を_削陀_しおしたうので、泚意しお䜿っおください。安党なのは `git reset --keep` を䜿うこずです。 ```sh (master)$ git reflog ``` 過去のコミットずリセットのコミットが衚瀺されるので、埩元したいコミットの SHA を遞んでリセットしたす ```sh (master)$ git reset --hard SHA1234 ``` これで倧䞈倫です。 ### 間違えおマヌゞをコミットしおプッシュしおしたった フィヌチャヌブランチをマヌゞの準備が敎う前に間違えおメむンのブランチにマヌゞしおしたった堎合、マヌゞを取り消すこずができたす。 ただし萜ずし穎がありたすマヌゞコミットには耇数通垞は二぀の芪がありたす。 次のコマンドを実行したす。 ```sh (feature-branch)$ git revert -m 1 ``` ここでオプション `-m 1` は芪 1マヌゞした先のブランチを差し戻す先の芪に指定するものです。 泚意芪の番号はコミット ID ではありたせん。マヌゞコミットの行には `Merge: 8e2ce2d 86ac2e7` のように曞かれおいたす。芪番号はこのコミットにおいお芪を指定するための 1 から始たる番号で、最初の番号は 1 番、次は 2 番、のように振られたす。 ### 間違えお機密情報を含むファむルをコミットしプッシュしおしたった 機密情報やプラむベヌトな情報パスワヌドやキヌ等を含むデヌタを誀っおプッシュしおしたった堎合、コミットを修正するこずができたす。 ただし、ひずたびデヌタをコミットしおプッシュしおしたったら、その内容は盗み取られる恐れがあるこずに留意しおください。 以䞋の手順でパブリックリポゞトリやロヌカルからデヌタを削陀するこずはできたすが、他の誰かが既にプルしおしたったデヌタを削陀するこずは**䞍可胜です**。 パスワヌドをコミットしおしたった堎合は**盎ちに倉曎しおください**。キヌをコミットしおしたった堎合は**盎ちに再生成したしょう**。 誰かが既に機密情報をプルしおしたった可胜性がある限り、プッシュしたコミットを修正するだけでは䞍十分です。 ファむルを線集しお機密情報を削陀したあず、次を実行したす。 ```sh (feature-branch)$ git add edited_file (feature-branch)$ git commit --amend --no-edit (feature-branch)$ git push --force-with-lease origin [branch] ``` ファむルごず削陀したいがロヌカルには残しおおきたい堎合、次を実行したす。 ```sh (feature-branch)$ git rm --cached sensitive_file echo sensitive_file >> .gitignore (feature-branch)$ git add .gitignore (feature-branch)$ git commit --amend --no-edit (feature-branch)$ git push --force-with-lease origin [branch] ``` あるいは、機密情報をロヌカルの環境倉数に保存しおおきたしょう。 ファむルごず削陀した䞊でロヌカルからも削陀したい堎合は、次を実行したす。 ```sh (feature-branch)$ git rm sensitive_file (feature-branch)$ git commit --amend --no-edit (feature-branch)$ git push --force-with-lease origin [branch] ``` 他のコミットを既にしおしたっおいる堎合぀たり、機密情報のコミットが盎前のコミットよりも以前である堎合は、リベヌスする必芁がありたす。 ### 倧容量のファむルに関する履歎を完党に削陀したい 削陀したいファむルが機密情報である堎合は[機密情報を削陀する方法](#i-accidentally-committed-and-pushed-files-containing-sensitive-data)を参照しおください。 最近のコミットで倧容量のファむルや䞍芁なファむルを削陀しおも、`.git` フォルダにある Git の履歎には残ので、`git clone` したずきに䜙蚈なファむルたでダりンロヌドしおしたうこずになりたす。 Even if you delete a large or unwanted file in a recent commit, it still exists in git history, in your repo's `.git` folder, and will make `git clone` download unneeded files. ここで説明する手順には匷制プッシュを必芁ずし、リポゞトリ履歎を倧きく倉曎しおしたいたす。リモヌトで共同䜜業しおいる人がいる堎合は、党員のロヌカルな線集履歎がプッシュされおいるこずをたず確認しおおいおください。 The actions in this part of the guide will require a force push, and rewrite large sections of repo history, so if you are working with remote collaborators, check first that any local work of theirs is pushed. 履歎を曞き換えるのには二぀の方法がありたす。ビルトむンの `git-filter-branch` ず [`bfg-repo-cleaner`](https://rtyley.github.io/bfg-repo-cleaner/) です。 `bfg` ぱレガントで性胜がよい䞀方、サヌドパヌティ補の゜フトをダりンロヌドしなければならず、Java も必芁です。 ここでは䞡方の方法を説明したす。 最埌のステップでは匷制プッシュをしたすが、リポゞトリの履歎の倧郚分を氞久に倉曎しおしたうため、通垞の匷制プッシュよりもなお特殊な配慮が必芁になりたす。 #### おすすめの方法サヌドパヌティ補の bfg を䜿う bfg-repo-cleaner を䜿うには Java が必芁です。[ここ](https://rtyley.github.io/bfg-repo-cleaner/)から bfg の jar ファむルをダりンロヌドしおください。 以䞋の䟋では `bfg.jar` を䜿いたすが、ダりンロヌドしたものには `bfg-1.13.0.jar` のようにバヌゞョン番号が぀いおいるかもしれたせん。 特定のファむルを削陀する堎合は次のようにしたす。 ```sh (master)$ git rm path/to/filetoremove (master)$ git commit -m "Commit removing filetoremove" (master)$ java -jar ~/Downloads/bfg.jar --delete-files filetoremove ``` bfg を䜿うずきは、ファむルがサブディレクトリにあるずきもそのたたのファむル名を入力するこずに泚意しおください。 パタヌンからファむルを削陀するこずもできたす。䟋えば ```sh (master)$ git rm *.jpg (master)$ git commit -m "Commit removing *.jpg" (master)$ java -jar ~/Downloads/bfg.jar --delete-files *.jpg ``` bfg は最新のコミットにあるファむルには圱響したせん。䟋えば、リポゞトリに耇数あった倧容量の .tga ファむルのうち䞀郚を以前のコミットで削陀したずしお、bfg を実行しおも最新のコミットにあるファむルはそのたたです。 なお、コミットでファむル名を倉曎した堎合、䟋えばもずもず `LargeFileFirstName.mp4` だったファむルが埌のコミットで `LargeFileSecondName.mp4` に倉曎されおいる堎合は、`java -jar ~/Downloads/bfg.jar --delete-files LargeFileSecondName.mp4` を実行しおも Git の履歎からは削陀されたせん。䞡方のファむル名それぞれに぀いお `--delete-files` を実行するか、パタヌンマッチで䞡方削陀しおください。 #### ビルトむンの方法git-filter-branch を䜿う `git-filter-branch` はややこしくお機胜も貧匱ですが、`bfg` のむンストヌルや実行ができなくおも䜿えたす。 以䞋では、`filepattern` を名前やパタヌン`*.jpg` などに眮き換えおください。パタヌンにマッチしたファむルの履歎が党おの履歎ずブランチから削陀されたす。 ```sh (master)$ git filter-branch --force --index-filter 'git rm --cached --ignore-unmatch filepattern' --prune-empty --tag-name-filter cat -- --all ``` 䜕をしおいるのか `--tag-name-filter cat` は煩雑ですが、これが最も簡単に元のタグを新しいコミットに぀ける `cat` を䜿った方法です。 `--prune-empty` は珟圚空のコミットを党お削陀したす。 #### 最埌のステップ: 倉曎した履歎をプッシュする ファむルを削陀したら、リポゞトリのものを壊しおしたっおいないか慎重に確認しおください。 䜕か壊しおしたった堎合は、リポゞトリを再床クロヌンしおやり盎すのが最も簡単です。 最埌のステップずしお、必芁に応じお Git ガベヌゞコレクションで .git フォルダの容量を最小化しおから、匷制プッシュしたす。 ```sh (master)$ git reflog expire --expire=now --all && git gc --prune=now --aggressive (master)$ git push origin --force --tags ``` リポゞトリの履歎をすべお曞き換えおいるので、`git push` の量が膚倧すぎお `“The remote end hung up unexpectedly”` ずいう゚ラヌが返るかもしれたせん。この堎合は Git の post buffer を増やしおみたす。 ```sh (master)$ git config http.postBuffer 524288000 (master)$ git push --force ``` うたくいかない堎合は、コミットを手䜜業で小分けにしおプッシュしたす。 プッシュが成功するたで、`` を増やしながら次のコマンドを詊しおください。 ```sh (master)$ git push -u origin HEAD~:refs/head/master --force ``` プッシュが最初に成功したら、通垞の`git push` が 成功するたで `` を埐々に枛らしおください。 ### 盎近でないコミットの内容を線集したい 耇数たずえば䞉件のコミットを行ったあず、文脈的に最初のコミットに属する䜜業をし忘れたこずに気づいたずしたす。 この䜜業を新たなコミットずしお行えばコヌドベヌスは綺麗に保おるものの、コミットがアトミックでなくなっおしたう同じ文脈の䜜業が同じコミットに属さないので、この状況は厄介です。 し忘れた䜜業が属するべきコミットを線集し、䜜業を取り入れ぀぀、その埌のコミットには手を぀けないようにしたいずき、`git rebase` が圹に立ちたす。 最埌から䞉件目のコミットを線集したいずしたす。 ```sh (your-branch)$ git rebase -i HEAD~4 ``` 䞊のコマンドで察話的リベヌスモヌドに入り、盎近䞉件のコミットを線集できるようになりたす。 テキスト゚ディタが開き、次のような内容が衚瀺されたす。 ```sh pick 9e1d264 The third last commit pick 4b6e19a The second to last commit pick f4037ec The last commit ``` これを次のように線集したす。 ```sh edit 9e1d264 The third last commit pick 4b6e19a The second to last commit pick f4037ec The last commit ``` これは最埌から䞉件目のコミットを線集し぀぀、他の二件はそのたたにするよう `rebase` に指瀺しおいたす。 テキスト゚ディタを保存しお終了したら、Git がリベヌスを始めたす。指定したコミットで止たり、そのコミットを線集できるようになりたす。 これで最初にコミットしたずきにし忘れた䜜業を適甚できたす。線集ずステヌゞによっお適甚したしょう。 その埌、次を実行したす。 ```sh (your-branch)$ git commit --amend ``` これはコミットメッセヌゞはそのたたでコミットを䜜り盎すよう Git に指瀺しおいたす。 これで面倒な䜜業は終わりです。 > ```sh (your-branch)$ git rebase --continue ``` あずは䞊を実行すれば完了です。 ## ステヌゞング ### バヌゞョン管理されおいるファむルを党郚ステヌゞしたい ```sh $ git add -u ``` #### バヌゞョン管理されおいるファむルの䞀郚をステヌゞするには ```sh # 拡匵子が .txt のファむルをステヌゞする $ git add -u *.txt # src ディレクトリ内の党ファむルをステヌゞする $ git add -u src/ ``` ### ステヌゞされた線集内容を盎前のコミットに远加したい ```sh (my-branch*)$ git commit --amend ``` コミットメッセヌゞを倉曎したくないずきは、コミットメッセヌゞを再利甚するよう Git に指瀺したす ```sh (my-branch*)$ git commit --amend -C HEAD ``` ### 新しいファむルの党郚ではなく䞀郚をステヌゞしたい 通垞、ファむルの䞀郚をステヌゞするには次を実行したす ```sh $ git add --patch filename.x ``` 短瞮圢は `-p` です。これにより察話モヌドが開きたす。 オプション `s` を぀けるずコミットを分割 (split) できたす。ただし、新しく䜜ったファむルの堎合このオプションは䜿えたせん。 ファむルを新たに远加するには、次を実行したす ```sh $ git add -N filename.x ``` オプション `e` を䜿うず、どの行を远加するか手動で遞択するこずができたす。 `git diff --cached` あるいは `git diff --staged` を実行するず、ステヌゞした行がロヌカルに保存されたものず比范しお衚瀺されたす。 ### 䞀぀のファむルに加えた線集を二぀の異なるコミットに远加したい `git add` はファむル党䜓をコミットに远加したす。 `git add -p` を䜿うず、どの線集内容を远加するか察話的に遞択できたす。 ### ステヌゞした線集内容が倚すぎるので、いく぀かのコミットに分割したい `git reset -p` を実行するず、パッチモヌドのリセットダむアログが開きたす。 `git add -p` ず䌌おいたすが、"yes" がステヌゞを取り消しお次のコミットから陀去するこずを意味する点で異なりたす。 ### ステヌゞされおいない線集内容をステヌゞし、ステヌゞされた線集内容のステヌゞを取り消したい 通垞は、ステヌゞされたファむルのステヌゞングを䞀旊党郚取り消したあず、コミットしたいものをピックするべきです。 ステヌゞされおいる線集ずされおいない線集を切り替えたいずきは、ステヌゞされた線集を蚘録しおおく仮のコミットを䜜成し、ステヌゞされおいないファむルをステヌゞしおスタッシュしたす。それから仮のコミットをリセットしお、スタッシュを pop したす。 ```sh $ git commit -m "WIP" $ git add . # バヌゞョン管理されおいないファむルも远加される $ git stash $ git reset HEAD^ $ git stash pop --index 0 ``` 泚意 1ここで `pop` を䜿うのは、操䜜を耇数回行っおも結果がなるべく倉わらないようにするためです。 泚意 2ここで `--index` を指定しないず、ステヌゞされたファむルはステヌゞされおいない扱いになりたす理由は[このリンク](https://stackoverflow.com/questions/31595873/git-stash-with-staged-files-does-stash-convert-staged-files-to-unstaged?answertab=active#tab-top)を参照しおください。 ## Unstaged Edits ### I want to move my unstaged edits to a new branch ```sh $ git checkout -b my-branch ``` ### I want to move my unstaged edits to a different, existing branch ```sh $ git stash $ git checkout my-branch $ git stash pop ``` ### I want to discard my local uncommitted changes (staged and unstaged) If you want to discard all your local staged and unstaged changes, you can do this: ```sh (my-branch)$ git reset --hard # or (master)$ git checkout -f ``` This will unstage all files you might have staged with `git add`: ```sh $ git reset ``` This will revert all local uncommitted changes (should be executed in repo root): ```sh $ git checkout . ``` You can also revert uncommitted changes to a particular file or directory: ```sh $ git checkout [some_dir|file.txt] ``` Yet another way to revert all uncommitted changes (longer to type, but works from any subdirectory): ```sh $ git reset --hard HEAD ``` This will remove all local untracked files, so only files tracked by Git remain: ```sh $ git clean -fd ``` `-x` will also remove all ignored files. ### I want to discard specific unstaged changes When you want to get rid of some, but not all changes in your working copy. Checkout undesired changes, keep good changes. ```sh $ git checkout -p # Answer y to all of the snippets you want to drop ``` Another strategy involves using `stash`. Stash all the good changes, reset working copy, and reapply good changes. ```sh $ git stash -p # Select all of the snippets you want to save $ git reset --hard $ git stash pop ``` Alternatively, stash your undesired changes, and then drop stash. ```sh $ git stash -p # Select all of the snippets you don't want to save $ git stash drop ``` ### I want to discard specific unstaged files When you want to get rid of one specific file in your working copy. ```sh $ git checkout myFile ``` Alternatively, to discard multiple files in your working copy, list them all. ```sh $ git checkout myFirstFile mySecondFile ``` ### I want to discard only my unstaged local changes When you want to get rid of all of your unstaged local uncommitted changes ```sh $ git checkout . ``` ### I want to discard all of my untracked files When you want to get rid of all of your untracked files ```sh $ git clean -f ``` ### I want to unstage a specific staged file Sometimes we have one or more files that accidentally ended up being staged, and these files have not been committed before. To unstage them: ```sh $ git reset -- ``` This results in unstaging the file and make it look like it's untracked. ## Branches ### I want to list all branches List local branches ```sh $ git branch ``` List remote branches ```sh $ git branch -r ``` List all branches (both local and remote) ```sh $ git branch -a ``` ### Create a branch from a commit ```sh $ git checkout -b ``` ### I pulled from/into the wrong branch This is another chance to use `git reflog` to see where your HEAD pointed before the bad pull. ```sh (master)$ git reflog ab7555f HEAD@{0}: pull origin wrong-branch: Fast-forward c5bc55a HEAD@{1}: checkout: checkout message goes here ``` Simply reset your branch back to the desired commit: ```sh $ git reset --hard c5bc55a ``` Done. ### I want to discard local commits so my branch is the same as one on the server Confirm that you haven't pushed your changes to the server. `git status` should show how many commits you are ahead of origin: ```sh (my-branch)$ git status # On branch my-branch # Your branch is ahead of 'origin/my-branch' by 2 commits. # (use "git push" to publish your local commits) # ``` One way of resetting to match origin (to have the same as what is on the remote) is to do this: ```sh (master)$ git reset --hard origin/my-branch ``` ### I committed to master instead of a new branch Create the new branch while remaining on master: ```sh (master)$ git branch my-branch ``` Reset the branch master to the previous commit: ```sh (master)$ git reset --hard HEAD^ ``` `HEAD^` is short for `HEAD^1`. This stands for the first parent of `HEAD`, similarly `HEAD^2` stands for the second parent of the commit (merges can have 2 parents). Note that `HEAD^2` is **not** the same as `HEAD~2` (see [this link](http://www.paulboxley.com/blog/2011/06/git-caret-and-tilde) for more information). Alternatively, if you don't want to use `HEAD^`, find out what the commit hash you want to set your master branch to (`git log` should do the trick). Then reset to that hash. `git push` will make sure that this change is reflected on your remote. For example, if the hash of the commit that your master branch is supposed to be at is `a13b85e`: ```sh (master)$ git reset --hard a13b85e HEAD is now at a13b85e ``` Checkout the new branch to continue working: ```sh (master)$ git checkout my-branch ``` ### I want to keep the whole file from another ref-ish Say you have a working spike (see note), with hundreds of changes. Everything is working. Now, you commit into another branch to save that work: ```sh (solution)$ git add -A && git commit -m "Adding all changes from this spike into one big commit." ``` When you want to put it into a branch (maybe feature, maybe `develop`), you're interested in keeping whole files. You want to split your big commit into smaller ones. Say you have: * branch `solution`, with the solution to your spike. One ahead of `develop`. * branch `develop`, where you want to add your changes. You can solve it bringing the contents to your branch: ```sh (develop)$ git checkout solution -- file1.txt ``` This will get the contents of that file in branch `solution` to your branch `develop`: ```sh # On branch develop # Your branch is up-to-date with 'origin/develop'. # Changes to be committed: # (use "git reset HEAD ..." to unstage) # # modified: file1.txt ``` Then, commit as usual. Note: Spike solutions are made to analyze or solve the problem. These solutions are used for estimation and discarded once everyone gets clear visualization of the problem. ~ [Wikipedia](https://en.wikipedia.org/wiki/Extreme_programming_practices). ### I made several commits on a single branch that should be on different branches Say you are on your master branch. Running `git log`, you see you have made two commits: ```sh (master)$ git log commit e3851e817c451cc36f2e6f3049db528415e3c114 Author: Alex Lee Date: Tue Jul 22 15:39:27 2014 -0400 Bug #21 - Added CSRF protection commit 5ea51731d150f7ddc4a365437931cd8be3bf3131 Author: Alex Lee Date: Tue Jul 22 15:39:12 2014 -0400 Bug #14 - Fixed spacing on title commit a13b85e984171c6e2a1729bb061994525f626d14 Author: Aki Rose Date: Tue Jul 21 01:12:48 2014 -0400 First commit ``` Let's take note of our commit hashes for each bug (`e3851e8` for #21, `5ea5173` for #14). First, let's reset our master branch to the correct commit (`a13b85e`): ```sh (master)$ git reset --hard a13b85e HEAD is now at a13b85e ``` Now, we can create a fresh branch for our bug #21: ```sh (master)$ git checkout -b 21 (21)$ ``` Now, let's *cherry-pick* the commit for bug #21 on top of our branch. That means we will be applying that commit, and only that commit, directly on top of whatever our head is at. ```sh (21)$ git cherry-pick e3851e8 ``` At this point, there is a possibility there might be conflicts. See the [**There were conflicts**](#merge-conflict) section in the [interactive rebasing section above](#interactive-rebase) for how to resolve conflicts. Now let's create a new branch for bug #14, also based on master ```sh (21)$ git checkout master (master)$ git checkout -b 14 (14)$ ``` And finally, let's cherry-pick the commit for bug #14: ```sh (14)$ git cherry-pick 5ea5173 ``` ### I want to delete local branches that were deleted upstream Once you merge a pull request on GitHub, it gives you the option to delete the merged branch in your fork. If you aren't planning to keep working on the branch, it's cleaner to delete the local copies of the branch so you don't end up cluttering up your working checkout with a lot of stale branches. ```sh $ git fetch -p upstream ``` where, `upstream` is the remote you want to fetch from. ### I accidentally deleted my branch If you're regularly pushing to remote, you should be safe most of the time. But still sometimes you may end up deleting your branches. Let's say we create a branch and create a new file: ```sh (master)$ git checkout -b my-branch (my-branch)$ git branch (my-branch)$ touch foo.txt (my-branch)$ ls README.md foo.txt ``` Let's add it and commit. ```sh (my-branch)$ git add . (my-branch)$ git commit -m 'foo.txt added' (my-branch)$ foo.txt added 1 files changed, 1 insertions(+) create mode 100644 foo.txt (my-branch)$ git log commit 4e3cd85a670ced7cc17a2b5d8d3d809ac88d5012 Author: siemiatj Date: Wed Jul 30 00:34:10 2014 +0200 foo.txt added commit 69204cdf0acbab201619d95ad8295928e7f411d5 Author: Kate Hudson Date: Tue Jul 29 13:14:46 2014 -0400 Fixes #6: Force pushing after amending commits ``` Now we're switching back to master and 'accidentally' removing our branch. ```sh (my-branch)$ git checkout master Switched to branch 'master' Your branch is up-to-date with 'origin/master'. (master)$ git branch -D my-branch Deleted branch my-branch (was 4e3cd85). (master)$ echo oh noes, deleted my branch! oh noes, deleted my branch! ``` At this point you should get familiar with 'reflog', an upgraded logger. It stores the history of all the action in the repo. ``` (master)$ git reflog 69204cd HEAD@{0}: checkout: moving from my-branch to master 4e3cd85 HEAD@{1}: commit: foo.txt added 69204cd HEAD@{2}: checkout: moving from master to my-branch ``` As you can see we have commit hash from our deleted branch. Let's see if we can restore our deleted branch. ```sh (master)$ git checkout -b my-branch-help Switched to a new branch 'my-branch-help' (my-branch-help)$ git reset --hard 4e3cd85 HEAD is now at 4e3cd85 foo.txt added (my-branch-help)$ ls README.md foo.txt ``` Voila! We got our removed file back. `git reflog` is also useful when rebasing goes terribly wrong. ### I want to delete a branch To delete a remote branch: ```sh (master)$ git push origin --delete my-branch ``` You can also do: ```sh (master)$ git push origin :my-branch ``` To delete a local branch: ```sh (master)$ git branch -d my-branch ``` To delete a local branch that *has not* been merged to the current branch or an upstream: ```sh (master)$ git branch -D my-branch ``` ### I want to delete multiple branches Say you want to delete all branches that start with `fix/`: ```sh (master)$ git branch | grep 'fix/' | xargs git branch -d ``` ### I want to rename a branch To rename the current (local) branch: ```sh (master)$ git branch -m new-name ``` To rename a different (local) branch: ```sh (master)$ git branch -m old-name new-name ``` To delete the `old-name` remote branch and push the `new-name` local branch: ```sh (master)$ git push origin :old_name new_name ``` ### I want to checkout to a remote branch that someone else is working on First, fetch all branches from remote: ```sh (master)$ git fetch --all ``` Say you want to checkout to `daves` from the remote. ```sh (master)$ git checkout --track origin/daves Branch daves set up to track remote branch daves from origin. Switched to a new branch 'daves' ``` (`--track` is shorthand for `git checkout -b [branch] [remotename]/[branch]`) This will give you a local copy of the branch `daves`, and any update that has been pushed will also show up remotely. ### I want to create a new remote branch from current local one ```sh $ git push HEAD ``` If you would also like to set that remote branch as upstream for the current one, use the following instead: ```sh $ git push -u HEAD ``` With the `upstream` mode and the `simple` (default in Git 2.0) mode of the `push.default` config, the following command will push the current branch with regards to the remote branch that has been registered previously with `-u`: ```sh $ git push ``` The behavior of the other modes of `git push` is described in the [doc of `push.default`](https://git-scm.com/docs/git-config#git-config-pushdefault). ### I want to set a remote branch as the upstream for a local branch You can set a remote branch as the upstream for the current local branch using: ```sh $ git branch --set-upstream-to [remotename]/[branch] # or, using the shorthand: $ git branch -u [remotename]/[branch] ``` To set the upstream remote branch for another local branch: ```sh $ git branch -u [remotename]/[branch] [local-branch] ``` ### I want to set my HEAD to track the default remote branch By checking your remote branches, you can see which remote branch your HEAD is tracking. In some cases, this is not the desired branch. ```sh $ git branch -r origin/HEAD -> origin/gh-pages origin/master ``` To change `origin/HEAD` to track `origin/master`, you can run this command: ```sh $ git remote set-head origin --auto origin/HEAD set to master ``` ### I made changes on the wrong branch You've made uncommitted changes and realise you're on the wrong branch. Stash changes and apply them to the branch you want: ```sh (wrong_branch)$ git stash (wrong_branch)$ git checkout (correct_branch)$ git stash apply ``` ## Rebasing and Merging ### I want to undo rebase/merge You may have merged or rebased your current branch with a wrong branch, or you can't figure it out or finish the rebase/merge process. Git saves the original HEAD pointer in a variable called ORIG_HEAD before doing dangerous operations, so it is simple to recover your branch at the state before the rebase/merge. ```sh (my-branch)$ git reset --hard ORIG_HEAD ``` ### I rebased, but I don't want to force push Unfortunately, you have to force push, if you want those changes to be reflected on the remote branch. This is because you have changed the history. The remote branch won't accept changes unless you force push. This is one of the main reasons many people use a merge workflow, instead of a rebasing workflow - large teams can get into trouble with developers force pushing. Use this with caution. A safer way to use rebase is not to reflect your changes on the remote branch at all, and instead to do the following: ```sh (master)$ git checkout my-branch (my-branch)$ git rebase -i master (my-branch)$ git checkout master (master)$ git merge --ff-only my-branch ``` For more, see [this SO thread](https://stackoverflow.com/questions/11058312/how-can-i-use-git-rebase-without-requiring-a-forced-push). ### I need to combine commits Let's suppose you are working in a branch that is/will become a pull-request against `master`. In the simplest case when all you want to do is to combine *all* commits into a single one and you don't care about commit timestamps, you can reset and recommit. Make sure the master branch is up to date and all your changes committed, then: ```sh (my-branch)$ git reset --soft master (my-branch)$ git commit -am "New awesome feature" ``` If you want more control, and also to preserve timestamps, you need to do something called an interactive rebase: ```sh (my-branch)$ git rebase -i master ``` If you aren't working against another branch you'll have to rebase relative to your `HEAD`. If you want to squash the last 2 commits, for example, you'll have to rebase against `HEAD~2`. For the last 3, `HEAD~3`, etc. ```sh (master)$ git rebase -i HEAD~2 ``` After you run the interactive rebase command, you will see something like this in your text editor: ```vim pick a9c8a1d Some refactoring pick 01b2fd8 New awesome feature pick b729ad5 fixup pick e3851e8 another fix # Rebase 8074d12..b729ad5 onto 8074d12 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like "squash", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # # These lines can be re-ordered; they are executed from top to bottom. # # If you remove a line here THAT COMMIT WILL BE LOST. # # However, if you remove everything, the rebase will be aborted. # # Note that empty commits are commented out ``` All the lines beginning with a `#` are comments, they won't affect your rebase. Then you replace `pick` commands with any in the list above, and you can also remove commits by removing corresponding lines. For example, if you want to **leave the oldest (first) commit alone and combine all the following commits with the second oldest**, you should edit the letter next to each commit except the first and the second to say `f`: ```vim pick a9c8a1d Some refactoring pick 01b2fd8 New awesome feature f b729ad5 fixup f e3851e8 another fix ``` If you want to combine these commits **and rename the commit**, you should additionally add an `r` next to the second commit or simply use `s` instead of `f`: ```vim pick a9c8a1d Some refactoring pick 01b2fd8 New awesome feature s b729ad5 fixup s e3851e8 another fix ``` You can then rename the commit in the next text prompt that pops up. ```vim Newer, awesomer features # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # rebase in progress; onto 8074d12 # You are currently editing a commit while rebasing branch 'master' on '8074d12'. # # Changes to be committed: # modified: README.md # ``` If everything is successful, you should see something like this: ```sh (master)$ Successfully rebased and updated refs/heads/master. ``` #### Safe merging strategy `--no-commit` performs the merge but pretends the merge failed and does not autocommit, giving the user a chance to inspect and further tweak the merge result before committing. `no-ff` maintains evidence that a feature branch once existed, keeping project history consistent. ```sh (master)$ git merge --no-ff --no-commit my-branch ``` #### I need to merge a branch into a single commit ```sh (master)$ git merge --squash my-branch ``` #### I want to combine only unpushed commits Sometimes you have several work in progress commits that you want to combine before you push them upstream. You don't want to accidentally combine any commits that have already been pushed upstream because someone else may have already made commits that reference them. ```sh (master)$ git rebase -i @{u} ``` This will do an interactive rebase that lists only the commits that you haven't already pushed, so it will be safe to reorder/fix/squash anything in the list. #### I need to abort the merge Sometimes the merge can produce problems in certain files, in those cases we can use the option `abort` to abort the current conflict resolution process, and try to reconstruct the pre-merge state. ```sh (my-branch)$ git merge --abort ``` This command is available since Git version >= 1.7.4 ### I need to update the parent commit of my branch Say I have a master branch, a feature-1 branch branched from master, and a feature-2 branch branched off of feature-1. If I make a commit to feature-1, then the parent commit of feature-2 is no longer accurate (it should be the head of feature-1, since we branched off of it). We can fix this with `git rebase --onto`. ```sh (feature-2)$ git rebase --onto feature-1 feature-2 ``` This helps in sticky scenarios where you might have a feature built on another feature that hasn't been merged yet, and a bugfix on the feature-1 branch needs to be reflected in your feature-2 branch. ### Check if all commits on a branch are merged To check if all commits on a branch are merged into another branch, you should diff between the heads (or any commits) of those branches: ```sh (master)$ git log --graph --left-right --cherry-pick --oneline HEAD...feature/120-on-scroll ``` This will tell you if any commits are in one but not the other, and will give you a list of any nonshared between the branches. Another option is to do this: ```sh (master)$ git log master ^feature/120-on-scroll --no-merges ``` ### Possible issues with interactive rebases #### The rebase editing screen says 'noop' If you're seeing this: ``` noop ``` That means you are trying to rebase against a branch that is at an identical commit, or is *ahead* of your current branch. You can try: * making sure your master branch is where it should be * rebase against `HEAD~2` or earlier instead #### There were conflicts If you are unable to successfully complete the rebase, you may have to resolve conflicts. First run `git status` to see which files have conflicts in them: ```sh (my-branch)$ git status On branch my-branch Changes not staged for commit: (use "git add ..." to update what will be committed) (use "git checkout -- ..." to discard changes in working directory) both modified: README.md ``` In this example, `README.md` has conflicts. Open that file and look for the following: ```vim <<<<<<< HEAD some code ========= some code >>>>>>> new-commit ``` You will need to resolve the differences between the code that was added in your new commit (in the example, everything from the middle line to `new-commit`) and your `HEAD`. If you want to keep one branch's version of the code, you can use `--ours` or `--theirs`: ```sh (master*)$ git checkout --ours README.md ``` - When *merging*, use `--ours` to keep changes from the local branch, or `--theirs` to keep changes from the other branch. - When *rebasing*, use `--theirs` to keep changes from the local branch, or `--ours` to keep changes from the other branch. For an explanation of this swap, see [this note in the Git documentation](https://git-scm.com/docs/git-rebase#git-rebase---merge). If the merges are more complicated, you can use a visual diff editor: ```sh (master*)$ git mergetool -t opendiff ``` After you have resolved all conflicts and tested your code, `git add` the files you have changed, and then continue the rebase with `git rebase --continue` ```sh (my-branch)$ git add README.md (my-branch)$ git rebase --continue ``` If after resolving all the conflicts you end up with an identical tree to what it was before the commit, you need to `git rebase --skip` instead. If at any time you want to stop the entire rebase and go back to the original state of your branch, you can do so: ```sh (my-branch)$ git rebase --abort ``` ## Stash ### Stash all edits To stash all the edits in your working directory ```sh $ git stash ``` If you also want to stash untracked files, use `-u` option. ```sh $ git stash -u ``` ### Stash specific files To stash only one file from your working directory ```sh $ git stash push working-directory-path/filename.ext ``` To stash multiple files from your working directory ```sh $ git stash push working-directory-path/filename1.ext working-directory-path/filename2.ext ``` ### Stash with message ```sh $ git stash save ``` or ```sh $ git stash push -m ``` ### Apply a specific stash from list First check your list of stashes with message using ```sh $ git stash list ``` Then apply a specific stash from the list using ```sh $ git stash apply "stash@{n}" ``` Here, 'n' indicates the position of the stash in the stack. The topmost stash will be position 0. Furthermore, using a time-based stash reference is also possible. ```sh $ git stash apply "stash@{2.hours.ago}" ``` ### Stash while keeping unstaged edits You can manually create a `stash commit`, and then use `git stash store`. ```sh $ git stash create $ git stash store -m CREATED_SHA1 ``` ## Finding ### I want to find a string in any commit To find a certain string which was introduced in any commit, you can use the following structure: ```sh $ git log -S "string to find" ``` Commons parameters: * `--source` means to show the ref name given on the command line by which each commit was reached. * `--all` means to start from every branch. * `--reverse` prints in reverse order, it means that will show the first commit that made the change. ### I want to find by author/committer To find all commits by author/committer you can use: ```sh $ git log --author= $ git log --committer= ``` Keep in mind that author and committer are not the same. The `--author` is the person who originally wrote the code; on the other hand, the `--committer`, is the person who committed the code on behalf of the original author. ### I want to list commits containing specific files To find all commits containing a specific file you can use: ```sh $ git log -- ``` You would usually specify an exact path, but you may also use wild cards in the path and file name: ```sh $ git log -- **/*.js ``` While using wildcards, it's useful to inform `--name-status` to see the list of committed files: ```sh $ git log --name-status -- **/*.js ``` ### I want to view the commit history for a specific function To trace the evolution of a single function you can use: ```sh $ git log -L :FunctionName:FilePath ``` Note that you can combine this with further `git log` options, like [revision ranges](https://git-scm.com/docs/gitrevisions) and [commit limits](https://git-scm.com/docs/git-log/#_commit_limiting). ### Find a tag where a commit is referenced To find all tags containing a specific commit: ```sh $ git tag --contains ``` ## Submodules ### Clone all submodules ```sh $ git clone --recursive git://github.com/foo/bar.git ``` If already cloned: ```sh $ git submodule update --init --recursive ``` ### Remove a submodule Creating a submodule is pretty straight-forward, but deleting them less so. The commands you need are: ```sh $ git submodule deinit submodulename $ git rm submodulename $ git rm --cached submodulename $ rm -rf .git/modules/submodulename ``` ## Miscellaneous Objects ### Copy a folder or file from one branch to another ```sh $ git checkout -- ``` ### Restore a deleted file First find the commit when the file last existed: ```sh $ git rev-list -n 1 HEAD -- filename ``` Then checkout that file: ``` git checkout deletingcommitid^ -- filename ``` ### Delete tag ```sh $ git tag -d $ git push :refs/tags/ ``` ### Recover a deleted tag If you want to recover a tag that was already deleted, you can do so by following these steps: First, you need to find the unreachable tag: ```sh $ git fsck --unreachable | grep tag ``` Make a note of the tag's hash. Then, restore the deleted tag with following, making use of [`git update-ref`](https://git-scm.com/docs/git-update-ref): ```sh $ git update-ref refs/tags/ ``` Your tag should now have been restored. ### Deleted Patch If someone has sent you a pull request on GitHub, but then deleted their original fork, you will be unable to clone their repository or to use `git am` as the [.diff, .patch](https://github.com/blog/967-github-secrets) URLs become unavailable. But you can checkout the PR itself using [GitHub's special refs](https://gist.github.com/piscisaureus/3342247). To fetch the content of PR#1 into a new branch called pr_1: ```sh $ git fetch origin refs/pull/1/head:pr_1 From github.com:foo/bar * [new ref] refs/pull/1/head -> pr_1 ``` ### Exporting a repository as a Zip file ```sh $ git archive --format zip --output /full/path/to/zipfile.zip master ``` ### Push a branch and a tag that have the same name If there is a tag on a remote repository that has the same name as a branch you will get the following error when trying to push that branch with a standard `$ git push ` command. ```sh $ git push origin error: dst refspec same matches more than one. error: failed to push some refs to '' ``` Fix this by specifying you want to push the head reference. ```sh $ git push origin refs/heads/ ``` If you want to push a tag to a remote repository that has the same name as a branch, you can use a similar command. ```sh $ git push origin refs/tags/ ``` ## Tracking Files ### I want to change a file name's capitalization, without changing the contents of the file ```sh (master)$ git mv --force myfile MyFile ``` ### I want to overwrite local files when doing a git pull ```sh (master)$ git fetch --all (master)$ git reset --hard origin/master ``` ### I want to remove a file from Git but keep the file ```sh (master)$ git rm --cached log.txt ``` ### I want to revert a file to a specific revision Assuming the hash of the commit you want is c5f567: ```sh (master)$ git checkout c5f567 -- file1/to/restore file2/to/restore ``` If you want to revert to changes made just 1 commit before c5f567, pass the commit hash as c5f567~1: ```sh (master)$ git checkout c5f567~1 -- file1/to/restore file2/to/restore ``` ### I want to list changes of a specific file between commits or branches Assuming you want to compare last commit with file from commit c5f567: ```sh $ git diff HEAD:path_to_file/file c5f567:path_to_file/file ``` Same goes for branches: ```sh $ git diff master:path_to_file/file staging:path_to_file/file ``` ### I want Git to ignore changes to a specific file This works great for config templates or other files that require locally adding credentials that shouldn't be committed. ```sh $ git update-index --assume-unchanged file-to-ignore ``` Note that this does *not* remove the file from source control - it is only ignored locally. To undo this and tell Git to notice changes again, this clears the ignore flag: ```sh $ git update-index --no-assume-unchanged file-to-stop-ignoring ``` ## Debugging with Git The [git-bisect](https://git-scm.com/docs/git-bisect) command uses a binary search to find which commit in your Git history introduced a bug. Suppose you're on the `master` branch, and you want to find the commit that broke some feature. You start bisect: ```sh $ git bisect start ``` Then you should specify which commit is bad, and which one is known to be good. Assuming that your *current* version is bad, and `v1.1.1` is good: ```sh $ git bisect bad $ git bisect good v1.1.1 ``` Now `git-bisect` selects a commit in the middle of the range that you specified, checks it out, and asks you whether it's good or bad. You should see something like: ```sh $ Bisecting: 5 revision left to test after this (roughly 5 step) $ [c44abbbee29cb93d8499283101fe7c8d9d97f0fe] Commit message $ (c44abbb)$ ``` You will now check if this commit is good or bad. If it's good: ```sh $ (c44abbb)$ git bisect good ``` and `git-bisect` will select another commit from the range for you. This process (selecting `good` or `bad`) will repeat until there are no more revisions left to inspect, and the command will finally print a description of the **first** bad commit. ## Configuration ### I want to add aliases for some Git commands On OS X and Linux, your git configuration file is stored in ```~/.gitconfig```. I've added some example aliases I use as shortcuts (and some of my common typos) in the ```[alias]``` section as shown below: ```vim [alias] a = add amend = commit --amend c = commit ca = commit --amend ci = commit -a co = checkout d = diff dc = diff --changed ds = diff --staged extend = commit --amend -C HEAD f = fetch loll = log --graph --decorate --pretty=oneline --abbrev-commit m = merge one = log --pretty=oneline outstanding = rebase -i @{u} reword = commit --amend --only s = status unpushed = log @{u} wc = whatchanged wip = rebase -i @{u} zap = fetch -p day = log --reverse --no-merges --branches=* --date=local --since=midnight --author=\"$(git config --get user.name)\" delete-merged-branches = "!f() { git checkout --quiet master && git branch --merged | grep --invert-match '\\*' | xargs -n 1 git branch --delete; git checkout --quiet @{-1}; }; f" ``` ### I want to add an empty directory to my repository You can’t! Git doesn’t support this, but there’s a hack. You can create a .gitignore file in the directory with the following contents: ``` # Ignore everything in this directory * # Except this file !.gitignore ``` Another common convention is to make an empty file in the folder, titled .gitkeep. ```sh $ mkdir mydir $ touch mydir/.gitkeep ``` You can also name the file as just .keep , in which case the second line above would be ```touch mydir/.keep``` ### I want to cache a username and password for a repository You might have a repository that requires authentication. In which case you can cache a username and password so you don't have to enter it on every push and pull. Credential helper can do this for you. ```sh $ git config --global credential.helper cache # Set git to use the credential memory cache ``` ```sh $ git config --global credential.helper 'cache --timeout=3600' # Set the cache to timeout after 1 hour (setting is in seconds) ``` To find a credential helper: ```sh $ git help -a | grep credential # Shows you possible credential helpers ``` For OS specific credential caching: ```sh $ git config --global credential.helper osxkeychain # For OSX ``` ```sh $ git config --global credential.helper manager # Git for Windows 2.7.3+ ``` ```sh $ git config --global credential.helper gnome-keyring # Ubuntu and other GNOME-based distros ``` More credential helpers can likely be found for different distributions and operating systems. ### I want to make Git ignore permissions and filemode changes ```sh $ git config core.fileMode false ``` If you want to make this the default behaviour for logged-in users, then use: ```sh $ git config --global core.fileMode false ``` ### I want to set a global user To configure user information used across all local repositories, and to set a name that is identifiable for credit when review version history: ```sh $ git config --global user.name “[firstname lastname]” ``` To set an email address that will be associated with each history marker: ```sh git config --global user.email “[valid-email]” ``` ### I want to add command line coloring for Git To set automatic command line coloring for Git for easy reviewing: ```sh $ git config --global color.ui auto ``` ## I've no idea what I did wrong So, you're screwed - you `reset` something, or you merged the wrong branch, or you force pushed and now you can't find your commits. You know, at some point, you were doing alright, and you want to go back to some state you were at. This is what `git reflog` is for. `reflog` keeps track of any changes to the tip of a branch, even if that tip isn't referenced by a branch or a tag. Basically, every time HEAD changes, a new entry is added to the reflog. This only works for local repositories, sadly, and it only tracks movements (not changes to a file that weren't recorded anywhere, for instance). ```sh (master)$ git reflog 0a2e358 HEAD@{0}: reset: moving to HEAD~2 0254ea7 HEAD@{1}: checkout: moving from 2.2 to master c10f740 HEAD@{2}: checkout: moving from master to 2.2 ``` The reflog above shows a checkout from master to the 2.2 branch and back. From there, there's a hard reset to an older commit. The latest activity is represented at the top labeled `HEAD@{0}`. If it turns out that you accidentally moved back, the reflog will contain the commit master pointed to (0254ea7) before you accidentally dropped 2 commits. ```sh $ git reset --hard 0254ea7 ``` Using `git reset` it is then possible to change master back to the commit it was before. This provides a safety net in case history was accidentally changed. (copied and edited from [Source](https://www.atlassian.com/git/tutorials/rewriting-history/git-reflog)). ## Git Shortcuts ### Git Bash Once you're comfortable with what the above commands are doing, you might want to create some shortcuts for Git Bash. This allows you to work a lot faster by doing complex tasks in really short commands. ```sh alias sq=squash function squash() { git rebase -i HEAD~$1 } ``` Copy those commands to your .bashrc or .bash_profile. ### PowerShell on Windows If you are using PowerShell on Windows, you can also set up aliases and functions. Add these commands to your profile, whose path is defined in the `$profile` variable. Learn more at the [About Profiles](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles) page on the Microsoft documentation site. ```powershell Set-Alias sq Squash-Commits function Squash-Commits { git rebase -i HEAD~$1 } ``` # Other Resources ## Books * [Learn Enough Git to Be Dangerous](https://www.learnenough.com/git-tutorial) - A book by Michael Hartl covering Git from basics * [Pro Git](https://git-scm.com/book/en/v2) - Scott Chacon and Ben Straub's excellent book about Git * [Git Internals](https://github.com/pluralsight/git-internals-pdf) - Scott Chacon's other excellent book about Git * [Nasa handbook](https://www.nasa.gov/sites/default/files/atoms/files/nasa_systems_engineering_handbook.pdf) ## Tutorials * [19 Git Tips For Everyday Use](https://www.alexkras.com/19-git-tips-for-everyday-use) - A list of useful Git one liners * [Atlassian's Git tutorial](https://www.atlassian.com/git/tutorials) Get Git right with tutorials from beginner to advanced. * [Learn Git branching](https://learngitbranching.js.org/) An interactive web based branching/merging/rebasing tutorial * [Getting solid at Git rebase vs. merge](https://medium.com/@porteneuve/getting-solid-at-git-rebase-vs-merge-4fa1a48c53aa) * [Git Commands and Best Practices Cheat Sheet](https://zeroturnaround.com/rebellabs/git-commands-and-best-practices-cheat-sheet) - A Git cheat sheet in a blog post with more explanations * [Git from the inside out](https://codewords.recurse.com/issues/two/git-from-the-inside-out) - A tutorial that dives into Git's internals * [git-workflow](https://github.com/asmeurer/git-workflow) - [Aaron Meurer](https://github.com/asmeurer)'s howto on using Git to contribute to open source repositories * [GitHub as a workflow](https://hugogiraudel.com/2015/08/13/github-as-a-workflow/) - An interesting take on using GitHub as a workflow, particularly with empty PRs * [Githug](https://github.com/Gazler/githug) - A game to learn more common Git workflows * [learnGitBranching](https://github.com/pcottle/learnGitBranching) - An interactive git visualization to challenge and educate! ## Scripts and Tools * [firstaidgit.io](http://firstaidgit.io/) A searchable selection of the most frequently asked Git questions * [git-extra-commands](https://github.com/unixorn/git-extra-commands) - a collection of useful extra Git scripts * [git-extras](https://github.com/tj/git-extras) - GIT utilities -- repo summary, repl, changelog population, author commit percentages and more * [git-fire](https://github.com/qw3rtman/git-fire) - git-fire is a Git plugin that helps in the event of an emergency by adding all current files, committing, and pushing to a new branch (to prevent merge conflicts). * [git-tips](https://github.com/git-tips/tips) - Small Git tips * [git-town](https://github.com/Originate/git-town) - Generic, high-level Git workflow support! http://www.git-town.com ## GUI Clients * [GitKraken](https://www.gitkraken.com/) - The downright luxurious Git client,for Windows, Mac & Linux * [git-cola](https://git-cola.github.io/) - another Git client for Windows and OS X * [GitUp](https://github.com/git-up/GitUp) - A newish GUI that has some very opinionated ways of dealing with Git's complications * [gitx-dev](https://rowanj.github.io/gitx/) - another graphical Git client for OS X * [Sourcetree](https://www.sourcetreeapp.com/) - Simplicity meets power in a beautiful and free Git GUI. For Windows and Mac. * [Tower](https://www.git-tower.com/) - graphical Git client for OS X (paid) * [tig](https://jonas.github.io/tig/) - terminal text-mode interface for Git * [Magit](https://magit.vc/) - Interface to Git implemented as an Emacs package. * [GitExtensions](https://github.com/gitextensions/gitextensions) - a shell extension, a Visual Studio 2010-2015 plugin and a standalone Git repository tool. * [Fork](https://git-fork.com/) - a fast and friendly Git client for Mac (beta) * [gmaster](https://gmaster.io/) - a Git client for Windows that has 3-way merge, analyze refactors, semantic diff and merge (beta) * [gitk](https://git-scm.com/docs/gitk) - a Git client for linux to allow simple view of repo state. * [SublimeMerge](https://www.sublimemerge.com/) - Blazing fast, extensible client that provides 3-way merges, powerful search and syntax highlighting, in active development.