Home Explore Help
Register Sign In
dsaravanan
/
reference
Watch 1
Star 1
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
reference
/
how-to-use-git-a-reference-guide.html

how-to-use-git-a-reference-guide.html 19 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. 

  4.       </button> How To Use Git: A Reference Guide
    5. 

  5.     </h1>
    6. 

  6. 

  7.     <span class="meta-section timestamp"><span class="tutorial-date-text"></span><span class="tutorial-date">October 10, 2018</span></span>
    8. 

  8. 

  9.           <div class="author-and-date">
    10. 

  10.             <div class="tutorial-author">
    11. 

  11.               Lisa Tagliaferri
    12. 

  12.             </div>
    13. 

  13.           </div>
    14. 

  14. 

  15.     <div class="content-body tutorial-content" data-growable-markdown>
    16. 

  16.       <h2 id="git-cheat-sheet">Git Cheat Sheet</h2>
    17. 

  17. 

  18. <h3 id="introduction">Introduction</h3>
    19. 

  19. 

  20. <p>Teams of developers and open-source software maintainers typically manage their projects through Git, a distributed version control system that supports collaboration. </p>
    21. 

  21. 

  22. <p>This cheat sheet-style guide provides a quick reference to commands that are useful for working and collaborating in a Git repository. To install and configure Git, be sure to read “<a href="https://www.digitalocean.com/community/tutorials/how-to-contribute-to-open-source-getting-started-with-git">How To Contribute to Open Source: Getting Started with Git</a>.”</p>
    23. 

  23. 

  24. <p><strong>How to Use This Guide:</strong></p>
    25. 

  25. 

  26. <ul>
    27. 

  27. <li>This guide is in cheat sheet format with self-contained command-line snippets.</li>
    28. 

  28. <li>Jump to any section that is relevant to the task you are trying to complete.</li>
    29. 

  29. <li>When you see <code><span class="highlight">highlighted text</span></code> in this guide’s commands, keep in mind that this text should refer to the commits and files in <em>your own</em> repository.</li>
    30. 

  30. </ul>
    31. 

  31. 

  32. <h2 id="set-up-and-initialization">Set Up and Initialization</h2>
    33. 

  33. 

  34. <p>Check your Git version with the following command, which will also confirm that Git is installed.</p>
    35. 

  35. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git --version
    36. 

  36. </li></ul></code></pre>
    37. 

  37. <p>You can initialize your current working directory as a Git repository with <code>init</code>.</p>
    38. 

  38. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git init
    39. 

  39. </li></ul></code></pre>
    40. 

  40. <p>To copy an existing Git repository hosted remotely, you’ll use <code>git clone</code> with the repo’s URL or server location (in the latter case you will use <code>ssh</code>).</p>
    41. 

  41. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git clone <span class="highlight">https://www.github.com/username/repo-name</span>
    42. 

  42. </li></ul></code></pre>
    43. 

  43. <p>Show your current Git directory’s remote repository.</p>
    44. 

  44. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git remote
    45. 

  45. </li></ul></code></pre>
    46. 

  46. <p>For a more verbose output, use the <code>-v</code> flag.</p>
    47. 

  47. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git remote -v
    48. 

  48. </li></ul></code></pre>
    49. 

  49. <p>Add the Git upstream, which can be a URL or can be hosted on a server (in the latter case, connect with <code>ssh</code>).</p>
    50. 

  50. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git remote add upstream <span class="highlight">https://www.github.com/username/repo-name</span>
    51. 

  51. </li></ul></code></pre>
    52. 

  52. <h2 id="staging">Staging</h2>
    53. 

  53. 

  54. <p>When you’ve modified a file and have marked it to go in your next commit, it is considered to be a staged file.</p>
    55. 

  55. 

  56. <p>Check the status of your Git repository, including files added that are not staged, and files that are staged. </p>
    57. 

  57. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git status
    58. 

  58. </li></ul></code></pre>
    59. 

  59. <p>To stage modified files, use the <code>add</code> command, which you can run multiple times before a commit. If you make subsequent changes that you want included in the next commit, you must run <code>add</code> again.</p>
    60. 

  60. 

  61. <p>You can specify the specific file with <code>add</code>.</p>
    62. 

  62. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git add <span class="highlight">my_script.py</span>
    63. 

  63. </li></ul></code></pre>
    64. 

  64. <p>With <code>.</code> you can add all files in the current directory including files that begin with a <code>.</code>.</p>
    65. 

  65. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git add .
    66. 

  66. </li></ul></code></pre>
    67. 

  67. <p>You can remove a file from staging while retaining changes within your working directory with <code>reset</code>.</p>
    68. 

  68. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git reset <span class="highlight">my_script.py</span>
    69. 

  69. </li></ul></code></pre>
    70. 

  70. <h2 id="committing">Committing</h2>
    71. 

  71. 

  72. <p>Once you have staged your updates, you are ready to commit them, which will record changes you have made to the repository.</p>
    73. 

  73. 

  74. <p>To commit staged files, you’ll run the <code>commit</code> command with your meaningful commit message so that you can track commits. </p>
    75. 

  75. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git commit -m "Commit message"
    76. 

  76. </li></ul></code></pre>
    77. 

  77. <p>You can condense staging all tracked files with committing them in one step.</p>
    78. 

  78. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git commit -am "Commit message"
    79. 

  79. </li></ul></code></pre>
    80. 

  80. <p>If you need to modify your commit message, you can do so with the <code>--amend</code> flag.</p>
    81. 

  81. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git commit --amend -m "New commit message"
    82. 

  82. </li></ul></code></pre>
    83. 

  83. <h2 id="branches">Branches</h2>
    84. 

  84. 

  85. <p>A branch in Git is a movable pointer to one of the commits in the repository, it allows you to isolate work and manage feature development and integrations. You can learn more about branches by reading the <a href="https://git-scm.com/book/en/v1/Git-Branching-What-a-Branch-Is">Git documentation</a>.</p>
    86. 

  86. 

  87. <p>List all current branches with the <code>branch</code> command. An asterisk (<code>*</code>) will appear next to your currently active branch.</p>
    88. 

  88. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git branch
    89. 

  89. </li></ul></code></pre>
    90. 

  90. <p>Create a new branch. You will remain on your currently active branch until you switch to the new one.</p>
    91. 

  91. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git branch <span class="highlight">new-branch</span>
    92. 

  92. </li></ul></code></pre>
    93. 

  93. <p>Switch to any existing branch and check it out into your current working directory.</p>
    94. 

  94. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git checkout <span class="highlight">another-branch</span>
    95. 

  95. </li></ul></code></pre>
    96. 

  96. <p>You can consolidate the creation and checkout of a new branch by using the <code>-b</code> flag.</p>
    97. 

  97. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git checkout -b <span class="highlight">new-branch</span>
    98. 

  98. </li></ul></code></pre>
    99. 

  99. <p>Rename your branch name.</p>
    100. 

  100. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git branch -m <span class="highlight">current-branch-name</span> <span class="highlight">new-branch-name</span>
    101. 

  101. </li></ul></code></pre>
    102. 

  102. <p>Merge the specified branch’s history into the one you’re currently working in. </p>
    103. 

  103. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git merge <span class="highlight">branch-name</span>
    104. 

  104. </li></ul></code></pre>
    105. 

  105. <p>Abort the merge, in case there are conflicts. </p>
    106. 

  106. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git merge --abort
    107. 

  107. </li></ul></code></pre>
    108. 

  108. <p>You can also select a particular commit to merge with <code>cherry-pick</code> with the string that references the specific commit. </p>
    109. 

  109. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git cherry-pick <span class="highlight">f7649d0</span>
    110. 

  110. </li></ul></code></pre>
    111. 

  111. <p>When you have merged a branch and no longer need the branch, you can delete it.</p>
    112. 

  112. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git branch -d <span class="highlight">branch-name</span>
    113. 

  113. </li></ul></code></pre>
    114. 

  114. <p>If you have not merged a branch to master, but are sure you want to delete it, you can <strong>force</strong> delete a branch.</p>
    115. 

  115. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git branch -D <span class="highlight">branch-name</span>
    116. 

  116. </li></ul></code></pre>
    117. 

  117. <h2 id="collaborate-and-update">Collaborate and Update</h2>
    118. 

  118. 

  119. <p>To download changes from another repository, such as the remote upstream, you’ll use <code>fetch</code>. </p>
    120. 

  120. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git fetch <span class="highlight">upstream</span>
    121. 

  121. </li></ul></code></pre>
    122. 

  122. <p>Merge the fetched commits.</p>
    123. 

  123. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git merge upstream/master
    124. 

  124. </li></ul></code></pre>
    125. 

  125. <p>Push or transmit your local branch commits to the remote repository branch.</p>
    126. 

  126. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git push origin master
    127. 

  127. </li></ul></code></pre>
    128. 

  128. <p>Fetch and merge any commits from the tracking remote branch.</p>
    129. 

  129. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git pull
    130. 

  130. </li></ul></code></pre>
    131. 

  131. <h2 id="inspecting">Inspecting</h2>
    132. 

  132. 

  133. <p>Display the commit history for the currently active branch.</p>
    134. 

  134. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git log
    135. 

  135. </li></ul></code></pre>
    136. 

  136. <p>Show the commits that changed a particular file. This follows the file regardless of file renaming.</p>
    137. 

  137. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git log --follow <span class="highlight">my_script.py</span>
    138. 

  138. </li></ul></code></pre>
    139. 

  139. <p>Show the commits that are on one branch and not on the other. This will show commits on <code><span class="highlight">a-branch</span></code> that are not on <code><span class="highlight">b-branch</span></code>.</p>
    140. 

  140. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git log <span class="highlight">a-branch</span>..<span class="highlight">b-branch</span>
    141. 

  141. </li></ul></code></pre>
    142. 

  142. <p>Look at reference logs (<code>reflog</code>) to see when the tips of branches and other references were last updated within the repository.</p>
    143. 

  143. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git reflog
    144. 

  144. </li></ul></code></pre>
    145. 

  145. <p>Show any object in Git via its commit string or hash in a more human-readable format.</p>
    146. 

  146. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git show <span class="highlight">de754f5</span>
    147. 

  147. </li></ul></code></pre>
    148. 

  148. <h2 id="show-changes">Show Changes</h2>
    149. 

  149. 

  150. <p>The <code>git diff</code> command shows changes between commits, branches, and more. You can read more fully about it through the <a href="https://git-scm.com/docs/git-diff">Git documentation</a>. </p>
    151. 

  151. 

  152. <p>Compare modified files that are on the staging area.</p>
    153. 

  153. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git diff --staged
    154. 

  154. </li></ul></code></pre>
    155. 

  155. <p>Display the diff of what is in <code><span class="highlight">a-branch</span></code> but is not in <code><span class="highlight">b-branch</span></code>.</p>
    156. 

  156. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git diff <span class="highlight">a-branch</span>..<span class="highlight">b-branch</span>
    157. 

  157. </li></ul></code></pre>
    158. 

  158. <p>Show the diff between two specific commits.</p>
    159. 

  159. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git diff <span class="highlight">61ce3e6</span>..<span class="highlight">e221d9c</span>
    160. 

  160. </li></ul></code></pre>
    161. 

  161. <h2 id="stashing">Stashing</h2>
    162. 

  162. 

  163. <p>Sometimes you’ll find that you made changes to some code, but before you finish you have to begin working on something else. You’re not quite ready to commit the changes you have made so far, but you don’t want to lose your work. The <code>git stash</code> command will allow you to save your local modifications and revert back to the working directory that is in line with the most recent <code>HEAD</code> commit.</p>
    164. 

  164. 

  165. <p>Stash your current work.</p>
    166. 

  166. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git stash
    167. 

  167. </li></ul></code></pre>
    168. 

  168. <p>See what you currently have stashed.</p>
    169. 

  169. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git stash list
    170. 

  170. </li></ul></code></pre>
    171. 

  171. <p>Your stashes will be named <code>stash@{0}</code>, <code>stash@{1}</code>, and so on.</p>
    172. 

  172. 

  173. <p>Show information about a particular stash.</p>
    174. 

  174. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git stash show stash@{<span class="highlight">0</span>}
    175. 

  175. </li></ul></code></pre>
    176. 

  176. <p>To bring the files in a current stash out of the stash while still retaining the stash, use <code>apply</code>.</p>
    177. 

  177. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git stash apply stash@{<span class="highlight">0</span>}
    178. 

  178. </li></ul></code></pre>
    179. 

  179. <p>If you want to bring files out of a stash, and no longer need the stash, use <code>pop</code>.</p>
    180. 

  180. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git stash pop stash@{<span class="highlight">0</span>}
    181. 

  181. </li></ul></code></pre>
    182. 

  182. <p>If you no longer need the files saved in a particular stash, you can <code>drop</code> the stash.</p>
    183. 

  183. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git stash drop stash@{<span class="highlight">0</span>}
    184. 

  184. </li></ul></code></pre>
    185. 

  185. <p>If you have multiple stashes saved and no longer need to use any of them, you can use <code>clear</code> to remove them.</p>
    186. 

  186. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git stash clear
    187. 

  187. </li></ul></code></pre>
    188. 

  188. <h2 id="ignoring-files">Ignoring Files</h2>
    189. 

  189. 

  190. <p>If you want to keep files in your local Git directory, but do not want to commit them to the project, you can add these files to your <code>.gitignore</code> file so that they do not cause conflicts.</p>
    191. 

  191. 

  192. <p>Use a text editor such as nano to add files to the <code>.gitignore</code> file.</p>
    193. 

  193. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">nano .gitignore
    194. 

  194. </li></ul></code></pre>
    195. 

  195. <p>To see examples of <code>.gitignore</code> files, you can look at GitHub’s <a href="https://github.com/github/gitignore"><code>.gitignore</code> template repo</a>.</p>
    196. 

  196. 

  197. <h2 id="rebasing">Rebasing</h2>
    198. 

  198. 

  199. <p>A rebase allows us to move branches around by changing the commit that they are based on. With rebasing, you can squash or reword commits.</p>
    200. 

  200. 

  201. <p>You can start a rebase by either calling the number of commits you have made that you want to rebase (<code>5</code> in the case below).</p>
    202. 

  202. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git rebase -i HEAD~<span class="highlight">5</span>
    203. 

  203. </li></ul></code></pre>
    204. 

  204. <p>Alternatively, you can rebase based on a particular commit string or hash.</p>
    205. 

  205. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git rebase -i <span class="highlight">074a4e5</span>
    206. 

  206. </li></ul></code></pre>
    207. 

  207. <p>Once you have squashed or reworded commits, you can complete the rebase of your branch on top of the latest version of the project’s upstream code. </p>
    208. 

  208. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git rebase <span class="highlight">upstream/master</span>
    209. 

  209. </li></ul></code></pre>
    210. 

  210. <p>To learn more about rebasing and updating, you can read <a href="https://www.digitalocean.com/community/tutorials/how-to-rebase-and-update-a-pull-request">How To Rebase and Update a Pull Request</a>, which is also applicable to any type of commit.</p>
    211. 

  211. 

  212. <h2 id="resetting">Resetting</h2>
    213. 

  213. 

  214. <p>Sometimes, including after a rebase, you need to reset your working tree. You can reset to a particular commit, and <strong>delete all changes</strong>, with the following command.</p>
    215. 

  215. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git reset --hard <span class="highlight">1fc6665</span>
    216. 

  216. </li></ul></code></pre>
    217. 

  217. <p>To force push your last known non-conflicting commit to the origin repository, you’ll need to use <code>--force</code>. </p>
    218. 

  218. 

  219. <p><span class='warning'><strong>Warning</strong>: Force pushing to master is often frowned upon unless there is a really important reason for doing it. Use sparingly when working on your own repositories, and work to avoid this when you’re collaborating.<br></span></p>
    220. 

  220. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git push --force origin master
    221. 

  221. </li></ul></code></pre>
    222. 

  222. <p>To remove local untracked files and subdirectories from the Git directory for a clean working branch, you can use <code>git clean</code>.</p>
    223. 

  223. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git clean -f -d
    224. 

  224. </li></ul></code></pre>
    225. 

  225. <p>If you need to modify your local repository so that it looks like the current upstream master (that is, there are too many conflicts), you can perform a hard reset.</p>
    226. 

  226. 

  227. <p><span class='note'><strong>Note</strong>: Performing this command will make your local repository look exactly like the upstream. Any commits you have made but that were not pulled into the upstream <strong>will be destroyed</strong>.<br></span></p>
    228. 

  228. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git reset --hard upstream/master
    229. 

  229. </li></ul></code></pre>
    230. 

  230. <h2 id="conclusion">Conclusion</h2>
    231. 

  231. 

  232. <p>This guide covers some of the more common Git commands you may use when managing repositories and collaborating on software. </p>
    233. 

  233. 

  234. <p>You can learn more about open-source software and collaboration in our <a href="https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source">Introduction to Open Source tutorial series</a>:</p>
    235. 

  235. 

  236. <ul>
    237. 

  237. <li><a href="https://www.digitalocean.com/community/tutorials/how-to-contribute-to-open-source-getting-started-with-git">How To Contribute to Open Source: Getting Started with Git</a></li>
    238. 

  238. <li><a href="https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github">How To Create a Pull Request on GitHub</a></li>
    239. 

  239. <li><a href="https://www.digitalocean.com/community/tutorials/how-to-rebase-and-update-a-pull-request">How To Rebase and Update a Pull Request</a></li>
    240. 

  240. <li><a href="https://www.digitalocean.com/community/tutorials/how-to-maintain-open-source-software-projects">How To Maintain Open-Source Software Projects</a></li>
    241. 

  241. </ul>
    242. 

  242. 

  243. <p>There are many more commands and variations that you may find useful as part of your work with Git. To learn more about all of your available options, you can run:</p>
    244. 

  244. <pre class="code-pre command"><code langs=""><ul class="prefixed"><li class="line" prefix="$">git --help
    245. 

  245. </li></ul></code></pre>
    246. 

  246. <p>To receive useful information. You can also read more about Git and look at Git’s documentation from the <a href="https://git-scm.com/">official Git website</a>.</p>
    247. 

  247. 

  248.     </div>
    249. 

  249. </div>
    250. 

  250. 

  251.   </body>
    252. 

  252. </html>
    253. 

  253.