No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.

827 líneas
81 KiB

hace 7 años
hace 7 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 6 años
hace 7 años
hace 7 años
hace 7 años
hace 7 años
hace 6 años
hace 7 años
hace 7 años
hace 7 años
hace 7 años
hace 6 años
hace 6 años
  1. [![](https://vsmarketplacebadge.apphb.com/version-short/eamodio.gitlens.svg)](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
  2. [![](https://vsmarketplacebadge.apphb.com/installs-short/eamodio.gitlens.svg)](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
  3. [![](https://vsmarketplacebadge.apphb.com/rating-short/eamodio.gitlens.svg)](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
  4. [![](https://img.shields.io/badge/vscode--dev--community-gitlens-blue.svg?logo=slack)](https://join.slack.com/t/vscode-dev-community/shared_invite/enQtMjIxOTgxNDE3NzM0LWU5M2ZiZDU1YjBlMzdlZjA2YjBjYzRhYTM5NTgzMTAxMjdiNWU0ZmQzYWI3MWU5N2Q1YjBiYmQ4MzY0NDE1MzY)
  5. <p align="center">
  6. <br />
  7. <a title="Learn more about GitLens" href="http://gitlens.amod.io"><img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/gitlens-logo.png" alt="GitLens Logo" /></a>
  8. </p>
  9. > GitLens **supercharges** the Git capabilities built into Visual Studio Code. It helps you to **visualize code authorship** at a glance via Git blame annotations and code lens, **seamlessly navigate and explore** Git repositories, **gain valuable insights** via powerful comparison commands, and so much more.
  10. <br />
  11. # What's new in GitLens 8
  12. ## 8.5 &mdash; July 2018
  13. - Adds an all-new *GitLens* sidebar view to contain the *GitLens*, *GitLens File History*, and *GitLens Results* explorers
  14. - The new view is enabled by default, but can easily be configured back to the existing locations via the *GitLens* interactive settings editor
  15. - Adds emoji support, e.g. :smile: in commit messages will now be 😃 &mdash; closes [#429](https://github.com/eamodio/vscode-gitlens/issues/429)
  16. - Adds *Compare with Selected* and *Select for Compare* commands to file nodes in the *GitLens*, *GitLens File History*, and *GitLens Results* explorers &mdash; closes [#446](https://github.com/eamodio/vscode-gitlens/issues/446)
  17. - Adds tag annotations to the tag tooltips in the *GitLens* explorer &mdash; closes [#431](https://github.com/eamodio/vscode-gitlens/issues/431)
  18. - Adds *Choose from Branch or Tag History...* to the quick pick menu shown by the *Show File History...* command (`gitlens.showQuickFileHistory`) &mdash; closes [#316](https://github.com/eamodio/vscode-gitlens/issues/316)
  19. - Adds the *Compare File with Revision...* command (`gitlens.diffWithRevision`) as an alternate (`alt+click`) for the *Compare File with Previous Revision* command in the editor toolbar
  20. - Adds *Checkout Commit (via Terminal)* command (`gitlens.terminalCheckoutCommit`) to commit node(s) of the *GitLens* explorer &mdash; closes [#463](https://github.com/eamodio/vscode-gitlens/issues/463)
  21. - Adds `gitlens.historyExplorer.avatars` setting to specify whether to show avatar images instead of status icons in the *GitLens File History* explorer &mdash; allows for an independent value from the other explorers
  22. - Adds a `gitlens.hovers.avatars` setting to specify whether to show avatar images in hovers &mdash; closes [#432](https://github.com/eamodio/vscode-gitlens/issues/432) thanks to [PR #441](https://github.com/eamodio/vscode-gitlens/pull/441) by Segev Finer ([@segevfiner](https://github.com/segevfiner))
  23. - Adds the `gitlens.hovers.avatars` setting to the *GitLens* interactive settings editor to specify whether to show avatar images in hovers
  24. - Adds *Copy Remote File Url to Clipboard* (`gitlens.copyRemoteFileUrlToClipboard`) command &mdash; copies the remote url of the current file and line to the clipboard &mdash; closes [#467](https://github.com/eamodio/vscode-gitlens/issues/467)
  25. - Improves performance of providing blame annotations, especially for large files (a ~33% improvement on some files)
  26. - Changes commit search by sha to jump directly to the commit (if one is found), rather than having to click through to the commit
  27. - Renames the *GitLens History* explorer to *GitLens File History* explorer for better clarity
  28. - Changes the *GitLens File History* explorer to always show the full file history even when reviewing revisions
  29. - Changes the behavior of and renames the *Show Branches and Tags* command and on the quick pick menu shown by the *Compare File with Revision...* command (`gitlens.diffWithRevision`) to *Choose from Branch or Tag History...*
  30. - Changes the behavior of and renames the *Show Branches and Tags* command on the quick pick menu shown by the *Open Revision...* command (`gitlens.openFileRevision`) to *Choose from Branch or Tag History...*
  31. - Changes *Rebase to Commit (via Terminal)* command (`gitlens.terminalRebaseCommit`) to apply to all commit node(s) of the *GitLens* explorer
  32. - Changes *Reset to Commit (via Terminal)* command (`gitlens.terminalResetCommit`) to apply to all commit node(s) of the *GitLens* explorer
  33. - Updates settings descriptions to better support the new settings editor in vscode
  34. - Removes `gitlens:activeIsTracked`, `gitlens:activeIsBlameable`, `gitlens:activeIsRevision`, and `gitlens:activeHasRemotes` contexts and consolidates them into `gitlens:activeFileStatus` for better performance and UX
  35. - Fixes [#436](https://github.com/eamodio/vscode-gitlens/issues/436) - Copy to clipboard not working
  36. - Fixes [#442](https://github.com/eamodio/vscode-gitlens/issues/442) - GitLens File History fails if name (or path) starts with `-`
  37. - Fixes [#440](https://github.com/eamodio/vscode-gitlens/issues/440) - Searching for commits with an empty query yields to no results anymore
  38. - Fixes [#444](https://github.com/eamodio/vscode-gitlens/issues/444) - GitLens custom viewlet icon slightly larger than standard
  39. - Fixes [#437](https://github.com/eamodio/vscode-gitlens/issues/437) - Remove `--first-parent` from git commands to show file history from merged in repositories
  40. - Fixes [#252](https://github.com/eamodio/vscode-gitlens/issues/252) - Cannot read property 'push' of undefined
  41. - Fixes [#451](https://github.com/eamodio/vscode-gitlens/issues/451) - "apply Changes" has discarded all my changes
  42. - Fixes [#449](https://github.com/eamodio/vscode-gitlens/issues/449) - Stop hiding explorers by default when in Zen mode
  43. - Fixes [#454](https://github.com/eamodio/vscode-gitlens/issues/454) - Search for string returns merge commits (unlike raw `git log -S`)
  44. - Fixes [#462](https://github.com/eamodio/vscode-gitlens/issues/462) - Source Control shortcut on macOS (⌃⇧G) shouldn't be overridden
  45. - Fixes [#457](https://github.com/eamodio/vscode-gitlens/issues/457) - Displays the wrong username (You) &mdash; thanks to [PR #460](https://github.com/eamodio/vscode-gitlens/pull/460) by Zyck ([@qzyse2017](https://github.com/qzyse2017))
  46. - Fixes [#459](https://github.com/eamodio/vscode-gitlens/issues/459) - File blame annotation text overflow with letter spacing setting
  47. - Fixes [#471](https://github.com/eamodio/vscode-gitlens/issues/471) - Don't use Ctrl+Alt+[character] as a shortcut
  48. - Fixes [#478](https://github.com/eamodio/vscode-gitlens/issues/478) - `suppressShowKeyBindingsNotice` gets saved even when it is not required
  49. - Fixes [#468](https://github.com/eamodio/vscode-gitlens/issues/468) - Commit history for detached HEAD doesn't work properly
  50. - Fixes issues with GitLens Welcome and the interactive settings editor with light themes
  51. - Fixes issue where commands in the editor toolbar would flash unnecessarily when navigating history or switching tabs
  52. - Fixes issue where the *Compare File with Previous Revision* command wouldn't work properly when the file had been renamed in some cases
  53. - Fixes issue where the *Compare File with Next Revision* command wouldn't work properly when the file had been renamed in some cases
  54. - Fixes issue where changed files count was wrong when the branch was behind the upstream
  55. - Fixes issue where the *GitLens File History* explorer wasn't being updated automatically for working changes
  56. - Fixes issue where the *Compare File with * Revision* commands in the editor toolbar would show and hide too often because of insignificant focus changes
  57. - Fixes issue where the scope box would be empty when there was no workspace open in the interactive settings editor
  58. - Fixes issue where GitLens saves a couple settings with default values into user settings (rather than just removing the setting)
  59. - Fixes issue showing changes with untracked stashed files
  60. - Fixes issue showing changes with working file when the file has been renamed
  61. See the [release notes](https://github.com/eamodio/vscode-gitlens/blob/master/CHANGELOG.md "Open Release Notes") for the full set of changes
  62. # GitLens
  63. [GitLens](http://gitlens.amod.io "Learn more about GitLens") is an [open-source](https://github.com/eamodio/vscode-gitlens "Open GitLens on GitHub") extension for [Visual Studio Code](https://code.visualstudio.com) created by [Eric Amodio](http://www.amod.io "Learn more about Eric").
  64. While GitLens is generously offered to everyone free of charge, if you find it useful please consider [supporting](#support-gitlens "Support GitLens") it.
  65. GitLens simply helps you understand code better. Quickly glimpse into whom, why, and when a line or code block was changed. Jump back through history to gain further insights as to how and why the code evolved. Explore the history and evolution of a codebase.
  66. Here are just some of the features that GitLens provides,
  67. - a [*GitLens* explorer](#gitlens-explorer "Jump to the GitLens explorer") to navigate and explore repositories
  68. - a [*GitLens File History* explorer](#gitlens-file-history-explorer "Jump to the GitLens File History explorer") to navigate and explore file histories
  69. - an on-demand [*GitLens Results* explorer](#gitlens-results-explorer "Jump to the GitLens Results explorer") to navigate and explore commit searches, visualize comparisons between branches, tags, commits, and more
  70. - authorship [code lens](#code-lens "Jump to the Code Lens") showing the most recent commit and # of authors to the top of files and/or on code blocks
  71. - an unobtrusive [current line blame](#current-line-blame "Jump to the Current Line Blame") annotation at the end of the line
  72. - on-demand [gutter blame](#gutter-blame "Jump to the Gutter Blame") annotations, including a heatmap, for the whole file
  73. - on-demand [gutter heatmap](#gutter-heatmap "Jump to the Gutter Heatmap") annotations to show how recently lines were changed, relative to all the other changes in the file and to now (hot vs. cold)
  74. - on-demand [recent changes](#recent-changes "Jump to the Recent Changes") annotations to highlight lines changed by the most recent commit
  75. - a [status bar blame](#status-bar-blame "Jump to the Status Bar Blame") annotation showing author and date for the current line
  76. - [commit search](#commit-search "Jump to the Commit Search") &mdash; by message, author, filename, commit id, or code changes
  77. - many powerful commands for exploring commits and histories, comparing and navigating revisions, stash access, repository status, etc
  78. - and so much [more](#features "Jump to Features")
  79. GitLens is powerful, feature rich, and also [highly customizable](#gitlens-settings "Jump to the GitLens settings docs") to meet your specific needs &mdash; find code lens intrusive or the current line blame annotation distracting &mdash; no problem, it is quick and easy to turn them off or change how they behave via the built-in [*GitLens Settings* editor](#configuration "Jump to Configuration"), an interactive editor covering many of GitLens' powerful settings. While for more advanced customizations, refer to the [GitLens settings docs](#gitlens-settings "Jump to the GitLens settings docs") and edit your vscode [user settings](https://code.visualstudio.com/docs/getstarted/settings "Open User settings").
  80. <p align="center">
  81. <br />
  82. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/gitlens-preview.gif" alt="GitLens Preview" />
  83. <br />
  84. </p>
  85. ## Support GitLens
  86. While GitLens is generously offered to everyone free of charge, if you find it useful please consider supporting it.
  87. I've been building GitLens in my spare time<sup><a title="nights and weekends, i.e. trading sleep for time">1</a></sup> for almost 2 years now.
  88. From its very humble beginnings, GitLens has grown wildly beyond my expectations &mdash; in both its reach as well as its demands on my time and attention.
  89. While I enjoy giving my free time and attention to GitLens' development and growth, I would like to do even more.
  90. ### Show Your Support &#x2764;
  91. To my incredible backers &mdash; thank you so much for your contributions. I am truly humbled by your generosity and support. Please know that your support plays a important role in helping me realize GitLens' potential in making developer's lives easier.
  92. If you'd like to join them in supporting GitLens, please consider the following &mdash; feel free to choose more than one. &#x1F609;
  93. - [Become a Sponsor](https://www.patreon.com/eamodio "Become a sponsor on Patreon") &mdash; join the growing group of generous [backers](https://github.com/eamodio/vscode-gitlens/blob/master/BACKERS.md)
  94. - [Donations via PayPal](https://www.paypal.me/eamodio "One-time donations via PayPal")
  95. - [Donations via Cash App](https://cash.me/$eamodio "One-time donations via Cash App")
  96. - [Write a Review](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens#review-details "Write a review")
  97. - [Star or Fork me on GitHub](https://github.com/eamodio/vscode-gitlens "Star or fork me on GitHub")
  98. - [Follow me on Twitter](https://twitter.com/eamodio "Follow me on Twitter")
  99. #### Gold Sponsors ($300+)
  100. None yet &mdash; could be you!
  101. #### Silver Sponsors ($150+)
  102. None yet &mdash; could be you!
  103. #### Bronze Sponsors ($50+)
  104. - Michael Duffy
  105. ## Configuration
  106. <p align="center">
  107. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-settings.png" alt="GitLens Explorer Repository view" />
  108. </p>
  109. GitLens has a built-in interactive settings editor which provides an easy-to-use interface to configure many of GitLens' powerful features. It can be accessed via the *Open Settings* (`gitlens.showSettingsPage`) command from the [*Command Palette*](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
  110. For more advanced customizations, refer to the [settings documentation](#gitlens-settings "Jump to the GitLens settings docs") below.
  111. ## Features
  112. ### GitLens Explorer
  113. A [customizable](#gitlens-explorer-settings "Jump to the GitLens Explorer settings") explorer to navigate and explore repositories or file histories. The *GitLens* explorer provides two views (modes) &mdash; a Repository view and a File History view.
  114. - A toolbar provides *Search Commits*, *Switch to Repository View* or *Switch to File History View*, and *Refresh* commands
  115. - Quickly switch between views using the *Switch to Repository View* or *Switch to File History View* commands
  116. - A context menu provides *Automatic Layout*, *List Layout*, *Tree Layout*, *Enable Automatic Refresh* or *Disable Automatic Refresh*, and *Follow Renames* or *Don't Follow Renames* commands
  117. #### Repository view
  118. <p align="center">
  119. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-explorer-repository.png" alt="GitLens Explorer Repository view" />
  120. </p>
  121. The repository view provides a full Git repository explorer, which has the following features,
  122. - **Repository Status**
  123. - Provides the name of the current branch, [optionally](#gitlens-explorer-settings "Jump to the GitLens explorer settings") its working tree status, and its upstream tracking branch and status (if available)
  124. - Provides indicator dots on the repository icon which denote the following:
  125. - *None* &mdash; up-to-date with the upstream
  126. - *Green* &mdash; ahead of the upstream
  127. - *Red* &mdash; behind the upstream
  128. - *Yellow* &mdash; both ahead of and behind the upstream
  129. - Provides additional upstream status nodes, if the current branch is tracking a remote branch and,
  130. - is behind the upstream &mdash; quickly see and explore the specific commits behind the upstream (i.e. commits that haven't been pulled)
  131. - is ahead of the upstream &mdash; quickly see and explore the specific commits ahead of the upstream (i.e. commits that haven't been pushed)
  132. - A context menu provides *Open Repository in Remote*, and *Refresh* commands
  133. - **Changed Files** &mdash; lists all the "working" changes
  134. - Expands to a file-based view of all changed files in the working tree ([optionally](#gitlens-explorer-settings "Jump to the GitLens explorer settings")) and/or all files in all commits ahead of the upstream
  135. - **History (current-branch)** &mdash; lists the revision (commit) history of the current branch
  136. - See the *Branches expand* section under **Branches** below for more details
  137. - **Branches** &mdash; lists the local branches
  138. - Indicates which branch is the current branch and [optionally](#gitlens-explorer-settings "Jump to the GitLens explorer settings") shows the remote tracking branch
  139. - A context menu provides *Open Branches in Remote*, and *Refresh* commands
  140. - Branches expand to show its revision (commit) history
  141. - Provides indicator dots on each branch icon which denote the following:
  142. - *None* &mdash; no upstream or up-to-date with the upstream
  143. - *Green* &mdash; ahead of the upstream
  144. - *Red* &mdash; behind the upstream
  145. - *Yellow* &mdash; both ahead of and behind the upstream
  146. - Context menus for each branch provide
  147. - *Open Branch in Remote* (if available), *Compare with Remote* (if available), *Compare with HEAD*, *Compare with Working Tree*, *Compare with Selected* (when available), *Compare Ancestry with Working Tree* (when available), *Select for Compare*, *Open Directory Compare with Working Tree*, *Checkout Branch (via Terminal)*, *Merge Branch (via Terminal)*, *Rebase (Interactive) Branch (via Terminal)*, *Rebase (Interactive) Branch to Remote (via Terminal)*, *Squash Branch into Commit (via Terminal)*, *Create Branch (via Terminal)...*, *Delete Branch (via Terminal)*, *Create Tag (via Terminal)...*, and *Refresh* commands
  148. - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  149. - Context menus for each revision (commit) provide
  150. - *Open Commit in Remote* (if available), *Open All Changes*, *Open All Changes with Working Tree*, *Open Files*, *Open Revisions*, *Copy Commit ID to Clipboard*, *Copy Commit Message to Clipboard*, *Show Commit Details*, *Compare with HEAD*, *Compare with Working Tree*, *Compare with Selected* (when available), *Select for Compare*, *Cherry Pick Commit (via Terminal)* (when available), *Push to Commit (via Terminal)* (when available), *Revert Commit (via Terminal)* (when available), *Checkout Commit (via Terminal)*, *Rebase to Commit (via Terminal)*, *Reset to Commit (via Terminal)*, *Create Branch (via Terminal)...*, *Create Tag (via Terminal)...*, and *Refresh* commands
  151. - Context menus for each changed file provide
  152. - *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in Remote*, *Open Revision in Remote*, *Copy Commit ID to Clipboard*, *Copy Commit Message to Clipboard*, *Copy Remote File Url to Clipboard*, *Apply Changes*, *Compare with Selected* (when available), *Select for Compare*, and *Show Commit File Details* commands
  153. - Inline toolbars for each changed file provide an *Open File* command
  154. - **Remotes** &mdash; lists the remotes
  155. - Indicates the direction of the remote (fetch, push, both), remote service (if applicable), and repository path
  156. - A context menu provides a *Refresh* command
  157. - Remotes expands show its list of branches
  158. - Context menus for each remote provide
  159. - *Open Branches in Remote*, *Open Repository in Remote*, *Remove Remote (via Terminal)*, and *Refresh* commands
  160. - Branches expand to show its revision (commit) history
  161. - See the *Branches expand* section under **Branches** above for more details
  162. - **Stashes** &mdash; lists the stashed changes
  163. - A context menu provides *Stash Changes*, and *Refresh* commands
  164. - Stashes expand to show the set of files stashed, complete with status indicators for adds, changes, renames, and deletes
  165. - Context menus for each stash provide
  166. - *Apply Stashed Changes* (confirmation required), *Delete Stashed Changes* (confirmation required), *Open All Changes*, *Open All Changes with Working Tree*, *Open Files*, *Open Revisions*, *Copy Commit Message to Clipboard*, *Compare with HEAD*, *Compare with Working Tree*, *Compare with Selected* (when available), *Select for Compare*, and *Refresh* commands
  167. - Context menus for each stashed file provide
  168. - *Apply Changes*, *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in Remote* (if available), *Compare with Selected* (when available), *Select for Compare*, and *Show File History* commands
  169. - **Tags** &mdash; lists the tags
  170. - A context menu provides a *Refresh* command
  171. - Tags expand to show its revision (commit) history
  172. - Context menus for each tag provide
  173. - *Compare with HEAD*, *Compare with Working Tree*, *Compare with Selected*, *Select for Compare*, *Open Directory Compare with Working Tree*, *Delete Tag (via Terminal)*, *Create Branch (via Terminal)*, and *Refresh* commands
  174. - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  175. - See the *Revisions (commits) expand* section under **Branches** above for more details
  176. ### File History view
  177. <p align="center">
  178. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-explorer-history.png" alt="GitLens Explorer File History view" />
  179. </p>
  180. The file history view provides the revision history of the current file, which has the following features,
  181. - Automatically updates to track the current editor
  182. - A context menu provides *Open File*, *Open File in Remote* (if available), and *Refresh* commands
  183. - An inline toolbar provides an *Open File* command
  184. - Context menus for each revision (commit) provides
  185. - *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in Remote* (if available), *Open Revision in Remote* (if available), *Apply Changes*, *Compare with Selected* (when available), *Select for Compare*, and *Show Commit File Details* commands
  186. ---
  187. ### GitLens File History Explorer
  188. <p align="center">
  189. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-history-explorer.png" alt="GitLens File History Explorer" />
  190. </p>
  191. A [customizable](#gitlens-file-history-explorer-settings "Jump to the GitLens File History Explorer settings") stand-alone explorer to visualize the history of the current file &mdash; undocked version of the *GitLens* Explorer history view
  192. - Automatically updates to track the current editor
  193. - A context menu provides *Open File*, *Open File in Remote* (if available), and *Refresh* commands
  194. - An inline toolbar provides an *Open File* command
  195. - Context menus for each revision (commit) provides
  196. - *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in Remote* (if available), *Open Revision in Remote* (if available), *Apply Changes*, *Compare with Selected* (when available), *Select for Compare*, and *Show Commit File Details* commands
  197. ---
  198. ### GitLens Results Explorer
  199. <p align="center">
  200. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-results.png" alt="GitLens Results explorer" />
  201. </p>
  202. An on-demand, [customizable](#gitlens-results-explorer-settings "Jump to the GitLens Results explorer settings") explorer to navigate and explore commits, histories, and searches, or visualize comparisons between branches, tags, commits, and more
  203. - A toolbar provides *Search Commits*, *Keep Results*, and *Refresh* commands
  204. - A context menu provides *Automatic Layout*, *List Layout*, *Tree Layout*, and *Close* commands
  205. #### Explore
  206. - Provides a semi-persistent results view for exploring histories, commits, and searches
  207. - Accessible via the following commands
  208. - *Show Commit Search* command (`gitlens.showCommitSearch`)
  209. - *Show File History* command (`gitlens.showQuickFileHistory`)
  210. - *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
  211. - An inline toolbar provides a *Clear Results* command
  212. - A context menu provides *Clear Results*, and *Refresh* commands
  213. - Revisions (commits) expand show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  214. - Context menus for each revision (commit) provide
  215. - *Open Commit in Remote* (if available), *Open All Changes*, *Open All Changes with Working Tree*, *Open Files*, *Open Revisions*, *Copy Commit ID to Clipboard*, *Copy Commit Message to Clipboard*, *Show Commit Details*, *Compare with HEAD*, *Compare with Working Tree*, *Compare with Selected* (when available), *Select for Compare*, *Cherry Pick Commit (via Terminal)* (when available), *Push to Commit (via Terminal)* (when available), *Revert Commit (via Terminal)* (when available), *Checkout Commit (via Terminal)*, *Rebase to Commit (via Terminal)*, *Reset to Commit (via Terminal)*, *Create Branch (via Terminal)...*, *Create Tag (via Terminal)...*, and *Refresh* commands
  216. - Context menus for each changed file provide
  217. - *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in Remote*, *Open Revision in Remote*, *Copy Commit ID to Clipboard*, *Copy Commit Message to Clipboard*, *Copy Remote File Url to Clipboard*, *Apply Changes*, *Compare with Selected* (when available), *Select for Compare*, and *Show Commit File Details* commands
  218. #### Compare
  219. - Provides a semi-persistent results view for comparison operations
  220. - Accessible via the following commands
  221. - *Compare with Remote* command (`gitlens.explorers.compareWithRemote`)
  222. - *Compare with HEAD* command (`gitlens.explorers.compareWithHead`)
  223. - *Compare with Working Tree* command (`gitlens.explorers.compareWithWorking`)
  224. - *Compare with Selected* command (`gitlens.explorers.compareWithSelected`)
  225. - *Compare Ancestry with Working Tree* command (`gitlens.explorers.compareAncestryWithWorking`)
  226. - An inline toolbar provides *Swap Comparision*, and *Clear Results* commands
  227. - A context menu provides *Clear Results*, *Swap Comparision*, *Open Directory Compare*, and *Refresh* commands
  228. - **Commits** &mdash; lists the commits between the compared revisions (branches or commits)
  229. - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  230. - See the *Revisions (commits) expand* section under **Explore** above for more details
  231. - **Changed Files** &mdash; lists the files changed between the compared revisions (branches or commits)
  232. - Expands to a file-based view of all changed files
  233. - Context menus for each changed file provide
  234. - *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in Remote*, *Open Revision in Remote*, *Copy Commit ID to Clipboard*, *Copy Commit Message to Clipboard*, *Copy Remote File Url to Clipboard*, *Apply Changes*, *Compare with Selected* (when available), *Select for Compare*, and *Show Commit File Details* commands
  235. ---
  236. ### Code Lens
  237. <p align="center">
  238. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-code-lens.png" alt="Code Lens" />
  239. </p>
  240. - Adds Git authorship **code lens** to the top of the file and on code blocks ([optional](#code-lens-settings "Jump to the Code Lens settings"), on by default)
  241. - **Recent Change** &mdash; author and date of the most recent commit for the file or code block
  242. - Click the code lens to show a **commit file details quick pick menu** with commands for comparing, navigating and exploring commits, and more (by [default](#code-lens-settings "Jump to the Code Lens settings"))
  243. - **Authors** &mdash; number of authors of the file or code block and the most prominent author (if there is more than one)
  244. - Click the code lens to toggle the file Git blame annotations on and off of the whole file (by [default](#code-lens-settings "Jump to the Code Lens settings"))
  245. - Will be hidden if the author of the most recent commit is also the only author of the file or block, to avoid duplicate information and reduce visual noise
  246. - Provides [customizable](#code-lens-settings "Jump to the Code Lens settings") click behavior for each code lens &mdash; choose between one of the following
  247. - Toggle file blame annotations on and off
  248. - Compare the commit with the previous commit
  249. - Show a quick pick menu with details and commands for the commit
  250. - Show a quick pick menu with file details and commands for the commit
  251. - Show a quick pick menu with the commit history of the file
  252. - Show a quick pick menu with the commit history of the current branch
  253. - Adds a *Toggle Git Code Lens* command (`gitlens.toggleCodeLens`) with a shortcut of `shift+alt+b` to toggle the code lens on and off
  254. ---
  255. ### Current Line Blame
  256. <p align="center">
  257. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-current-line-blame.png" alt="Current Line Blame" />
  258. </p>
  259. - Adds an unobtrusive, [customizable](#current-line-blame-settings "Jump to the Current Line Blame settings"), and [themable](#themable-colors "Jump to the Themable Colors"), **blame annotation** at the end of the current line
  260. - Contains the author, date, and message of the current line's most recent commit (by [default](#current-line-blame-settings "Jump to the Current Line Blame settings"))
  261. - Adds a *Toggle Line Blame Annotations* command (`gitlens.toggleLineBlame`) to toggle the blame annotation on and off
  262. ---
  263. ### Gutter Blame
  264. <p align="center">
  265. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gutter-blame.png" alt="Gutter Blame">
  266. </p>
  267. - Adds on-demand, [customizable](#gutter-blame-settings "Jump to the Gutter Blame settings"), and [themable](#themable-colors "Jump to the Themable Colors"), **gutter blame annotations** for the whole file
  268. - Contains the commit message and date, by [default](#gutter-blame-settings "Jump to the Gutter Blame settings")
  269. - Adds a **heatmap** (age) indicator on right edge (by [default](#gutter-blame-settings "Jump to the Gutter Blame settings")) of the gutter to provide an easy, at-a-glance way to tell how recently lines were changed ([optional](#gutter-blame-settings "Jump to the Gutter Blame settings"), on by default)
  270. - See the [gutter heatmap](#gutter-Heatmap "Jump to the Gutter Heatmap") section below for more details
  271. - Adds a *Toggle File Blame Annotations* command (`gitlens.toggleFileBlame`) with a shortcut of `alt+b` to toggle the blame annotations on and off
  272. - Press `Escape` to turn off the annotations
  273. ---
  274. ### Gutter Heatmap
  275. <p align="center">
  276. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-heatmap.png" alt="Gutter Heatmap" />
  277. </p>
  278. - Adds an on-demand **heatmap** to the edge of the gutter to show how recently lines were changed
  279. - The indicator's [customizable](#gutter-heatmap-settings "Jump to the Gutter Heatmap settings") color will either be hot or cold based on the age of the most recent change (cold after 90 days by [default](#gutter-heatmap-settings "Jump to the Gutter Heatmap settings"))
  280. - The indicator's brightness ranges from bright (newer) to dim (older) based on the relative age, which is calculated from the median age of all the changes in the file
  281. - Adds *Toggle File Heatmap Annotations* command (`gitlens.toggleFileHeatmap`) to toggle the heatmap on and off
  282. - Press `Escape` to turn off the annotations
  283. ---
  284. ### Hovers
  285. #### Current Line Hovers
  286. <p align="center">
  287. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-current-line.png" alt="Current Line Hovers" />
  288. </p>
  289. - Adds [customizable](#hover-settings "Jump to the Hover settings") Git blame hovers accessible over the current line
  290. ##### Details Hover
  291. <p align="center">
  292. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-current-line-details.png" alt="Current Line Details Hover" />
  293. </p>
  294. - Adds a **details hover** annotation to the current line to show more commit details ([optional](#hover-settings "Jump to the Hover settings"), on by default)
  295. - Provides automatic issue linking to Bitbucket, GitHub, GitLab, and Visual Studio Team Services in commit messages
  296. - Provides a **quick-access command bar** with *Open Changes*, *Blame Previous Revision*, *Open in Remote*, and *Show More Actions* command buttons
  297. - Click the commit id to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
  298. ##### Changes (diff) Hover
  299. <p align="center">
  300. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-current-line-changes.png" alt="Current Line Changes (diff) Hover" />
  301. </p>
  302. - Adds a **changes (diff) hover** annotation to the current line to show the line's previous version ([optional](#hover-settings "Jump to the Hover settings"), on by default)
  303. - Click the **Changes** to execute the *Compare File Revisions* command (`gitlens.diffWith`)
  304. - Click the current and previous commit ids to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
  305. #### Annotation Hovers
  306. <p align="center">
  307. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-annotations.png" alt="Annotation Hovers" />
  308. </p>
  309. - Adds [customizable](#hover-settings "Jump to the Hover settings") Git blame hovers accessible when annotating
  310. ##### Details Hover
  311. <p align="center">
  312. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-annotations-details.png" alt="Annotations Details Hover" />
  313. </p>
  314. - Adds a **details hover** annotation to each line while annotating to show more commit details ([optional](#hover-settings "Jump to the Hover settings"), on by default)
  315. - Provides automatic issue linking to Bitbucket, GitHub, GitLab, and Visual Studio Team Services in commit messages
  316. - Provides a **quick-access command bar** with *Open Changes*, *Blame Previous Revision*, *Open in Remote*, and *Show More Actions* command buttons
  317. - Click the commit id to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
  318. ##### Changes (diff) Hover
  319. <p align="center">
  320. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-annotations-changes.png" alt="Annotations Changes (diff) Hover" />
  321. </p>
  322. - Adds a **changes (diff) hover** annotation to each line while annotating to show the line's previous version ([optional](#hover-settings "Jump to the Hover settings"), on by default)
  323. - Click the **Changes** to execute the *Compare File Revisions* command (`gitlens.diffWith`)
  324. - Click the current and previous commit ids to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
  325. ---
  326. ### Modes
  327. - GitLens supports [user-defined](#modes-settings "Jump to the Modes settings") modes for quickly toggling between sets of settings
  328. - Adds *Switch Mode* command (`gitlens.switchMode`) to quickly switch the active mode
  329. - Adds a built-in *Zen* mode which for a zen-like experience, disables many visual features
  330. - Adds *Toggle Zen Mode* command (`gitlens.toggleZenMode`) to toggle Zen mode
  331. - Adds a built-in *Review* mode which for reviewing code, enables many visual features
  332. - Adds *Toggle Review Mode* command (`gitlens.toggleReviewMode`) to toggle Review mode
  333. - Adds the active mode to the **status bar** ([optional](#modes-settings "Jump to the Modes settings"), on by default)
  334. ---
  335. ### Recent Changes
  336. <p align="center">
  337. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-recent-changes.png" alt="Recent Changes" />
  338. </p>
  339. - Adds an on-demand, [customizable](#recent-changes-settings "Jump to the Recent Changes settings") and [themable](#themable-colors "Jump to the Themable Colors"), **recent changes annotation** to highlight lines changed by the most recent commit
  340. - Adds *Toggle Recent File Changes Annotations* command (`gitlens.toggleFileRecentChanges`) to toggle the recent changes annotations on and off
  341. - Press `Escape` to turn off the annotations
  342. ---
  343. ### Status Bar Blame
  344. <p align="center">
  345. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-status-bar.png" alt="Status Bar Blame" />
  346. </p>
  347. - Adds a [customizable](#status-bar-settings "Jump to the Status Bar Blame settings") **Git blame annotation** about the current line to the **status bar** ([optional](#status-bar-settings "Jump to the Status Bar Blame settings"), on by default)
  348. - Contains the commit author and date (by [default](#status-bar-settings "Jump to the Status Bar Blame settings"))
  349. - Click the status bar item to show a **commit details quick pick menu** with commands for comparing, navigating and exploring commits, and more (by [default](#status-bar-settings "Jump to the Status Bar Blame settings"))
  350. - Provides [customizable](#status-bar-settings "Jump to the Status Bar Blame settings") click behavior &mdash; choose between one of the following
  351. - Toggle file blame annotations on and off
  352. - Toggle code lens on and off
  353. - Compare the line commit with the previous commit
  354. - Compare the line commit with the working tree
  355. - Show a quick pick menu with details and commands for the commit (default)
  356. - Show a quick pick menu with file details and commands for the commit
  357. - Show a quick pick menu with the commit history of the file
  358. - Show a quick pick menu with the commit history of the current branch
  359. ---
  360. ### Commit Search
  361. - Adds a *Search Commits* command (`gitlens.showCommitSearch`) with a shortcut of `alt+/` to search for commits by message, author, file(s), commit id, or code changes
  362. - Use `<message>` to search for commits with messages that match `<message>` &mdash; See [Git docs](https://git-scm.com/docs/git-log#git-log---grepltpatterngt "Open Git docs")
  363. - Use `@<pattern>` to search for commits with authors that match `<pattern>` &mdash; See [Git docs](https://git-scm.com/docs/git-log#git-log---authorltpatterngt "Open Git docs")
  364. - Use `:<pattern>` to search for commits with file names that match `<pattern>` &mdash; See [Git docs](https://git-scm.com/docs/git-log "Open Git docs")
  365. - Use `#<sha>` to search for a commit with id of `<sha>` &mdash; See [Git docs](https://git-scm.com/docs/git-log "Open Git docs")
  366. - Use `~<pattern>` to search for commits with differences whose patch text contains added/removed lines that match `<pattern>` &mdash; See [Git docs](https://git-scm.com/docs/git-log#git-log--Gltregexgt "Open Git docs")
  367. - Use `=<string>` to search for commits with differences that change the number of occurrences of the specified string (i.e. addition/deletion) in a file &mdash; See [Git docs](https://git-scm.com/docs/git-log#git-log--Sltstringgt "Open Git docs")
  368. - Provides a *Show in Results* option to show the search results in the *GitLens Results* explorer
  369. ---
  370. ### Navigate and Explore
  371. - Adds a *Show Last Opened Quick Pick* command (`gitlens.showLastQuickPick`) with a shortcut of `alt+-` to quickly get back to where you were when the last GitLens quick pick menu closed
  372. - Adds commands to open files, commits, branches, and the repository in the supported remote services, **Bitbucket, GitHub, GitLab, and Visual Studio Team Services** or a [**user-defined** remote services](#custom-remotes-settings "Jump to Custom Remotes settings") &mdash; only available if a Git upstream service is configured in the repository
  373. - Also supports [remote services with custom domains](#custom-remotes-settings "Jump to Custom Remotes settings"), such as **Bitbucket, Bitbucket Server (previously called Stash), GitHub, GitHub Enterprise, GitLab**
  374. - *Open Branches in Remote* command (`gitlens.openBranchesInRemote`) &mdash; opens the branches in the supported remote service
  375. - *Open Branch in Remote* command (`gitlens.openBranchInRemote`) &mdash; opens the current branch commits in the supported remote service
  376. - *Open Commit in Remote* command (`gitlens.openCommitInRemote`) &mdash; opens the commit revision of the current line in the supported remote service
  377. - *Open File in Remote* command (`gitlens.openFileInRemote`) &mdash; opens the current file/revision in the supported remote service
  378. - *Open Repository in Remote* command (`gitlens.openRepoInRemote`) &mdash; opens the repository in the supported remote service
  379. #### Branch History
  380. <p align="center">
  381. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-branch-history.png" alt="Branch History Quick Pick Menu" />
  382. </p>
  383. - Adds a *Show Current Branch History* command (`gitlens.showQuickRepoHistory`) with a shortcut of `shift+alt+h` to show a paged **branch history quick pick menu** of the current branch for exploring its commit history
  384. - Provides entries to *Show Commit Search* and *Open Branch in \<remote-service\>* when available
  385. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  386. - Navigate pages via `alt+,` and `alt+.` to go backward and forward respectively
  387. - Adds a *Show Branch History* command (`gitlens.showQuickBranchHistory`) to show a paged **branch history quick pick menu** of the selected branch for exploring its commit history
  388. - Provides the same features as *Show Current Branch History* above
  389. #### File History
  390. <p align="center">
  391. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-file-history.png" alt="File History Quick Pick Menu" />
  392. </p>
  393. - Adds a *Show File History* command (`gitlens.showQuickFileHistory`) to show a paged **file history quick pick menu** of the current file for exploring its commit history
  394. - Provides additional entries to *Show in Results*, *Show Branch History*, and *Open File in \<remote-service\>* when available
  395. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  396. - Navigate pages via `alt+,` and `alt+.` to go backward and forward respectively
  397. #### Commit Details
  398. <p align="center">
  399. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-commit-details.png" alt="Commit Details Quick Pick Menu" />
  400. </p>
  401. - Adds a *Show Commit Details* command (`gitlens.showQuickCommitDetails`) to show a **commit details quick pick menu** of the most recent commit of the current file
  402. - Quickly see the set of files changed in the commit, complete with status indicators for adds, changes, renames, and deletes
  403. - Provides additional entries to *Show in Results*, *Open Commit in \<remote-service\>* when available, *Open Files*, *Open Revisions*, *Open Directory Compare with Previous Revision*, *Open Directory Compare with Working Tree*, *Copy Commit ID to Clipboard*, *Copy Commit Message to Clipboard*
  404. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  405. - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible &mdash; commands that open windows outside of VS Code will still close the quick pick menu unless [`"gitlens.advanced.quickPick.closeOnFocusOut": false`](#advanced-settings "Jump to Advanced settings") is set
  406. - Use the `alt+right arrow` shortcut on a file entry in the `Changed Files` section to preview the comparison of the current revision with the previous one
  407. <p align="center">
  408. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-commit-file-details.png" alt="Commit File Details Quick Pick Menu" />
  409. </p>
  410. - Adds a *Show Commit File Details* command (`gitlens.showQuickCommitFileDetails`) with a shortcut of `alt+c` to show a **file commit details quick pick menu** of the most recent commit of the current file
  411. - Provides entries to *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in \<remote-service\>* when available, *Open Revision in \<remote-service\>* when available, *Copy Commit ID to Clipboard*, *Copy Commit Message to Clipboard*, *Show Commit Details*, *Show File History*, and *Show Previous File History*
  412. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  413. - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible &mdash; commands that open windows outside of VS Code will still close the quick pick menu unless [`"gitlens.advanced.quickPick.closeOnFocusOut": false`](#advanced-settings "Jump to Advanced settings") is set
  414. #### Repository Status
  415. <p align="center">
  416. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-repo-status.png" alt="Repository Status Quick Pick Menu" />
  417. </p>
  418. - Adds a *Show Repository Status* command (`gitlens.showQuickRepoStatus`) with a shortcut of `alt+s` to show a **repository status quick pick menu** for visualizing the current repository status
  419. - Quickly see upstream status (if an Git upstream is configured) &mdash; complete with ahead and behind information
  420. - If you are ahead of the upstream, an entry will be shown with the number of commits ahead. Choosing it will show a limited **branch history quick pick menu** containing just the commits ahead of the upstream
  421. - If you are behind the upstream, an entry will be shown with the number of commits behind. Choosing it will show a limited **branch history quick pick menu** containing just the commits behind the upstream
  422. - Quickly see all working changes, both staged and unstaged, complete with status indicators for adds, changes, renames, and deletes
  423. - Provides entries to *Show Stashed Changes*, *Open Changed Files*, and *Close Unchanged Files*
  424. - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible &mdash; commands that open windows outside of VS Code will still close the quick pick menu unless [`"gitlens.advanced.quickPick.closeOnFocusOut": false`](#advanced-settings "Jump to Advanced settings") is set
  425. - Use the `alt+right arrow` shortcut on a file entry in the `Staged Files` or `Unstaged Files` sections to preview the comparison of the working file with the previous revision
  426. #### Stashes
  427. <p align="center">
  428. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-stash-list.png" alt="Stashed Changes Quick Pick Menu" />
  429. </p>
  430. - Adds a *Show Stashed Changes* command (`gitlens.showQuickStashList`) to show a **stashed changes quick pick menu** for exploring your repository stash history
  431. - Provides additional entries to *Stash Changes*
  432. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  433. - Adds a *Stash Changes* command (`gitlens.stashSave`) to save any working tree changes to the stash &mdash; can optionally provide a stash message
  434. - Also adds the command to the Source Control items context menu to stash an individual or group of files, works with multi-select too!
  435. #### Stash Details
  436. <p align="center">
  437. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-stash-details.png" alt="Stash Details Quick Pick Menu" />
  438. </p>
  439. - Stashed changes show a **stash details quick pick menu** which is very similar to the **commit details quick pick menu** above
  440. - Quickly see the set of files changed in the stash, complete with status indicators for adds, changes, renames, and deletes
  441. - Provides additional entries to *Apply Stashed Changes* (requires confirmation), *Delete Stashed Changes* (requires confirmation), *Open Files*, *Open Revisions*, *Open Directory Compare with Previous Revision*, *Open Directory Compare with Working Tree*, *Copy Commit Message to Clipboard*
  442. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  443. - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible &mdash; commands that open windows outside of VS Code will still close the quick pick menu unless [`"gitlens.advanced.quickPick.closeOnFocusOut": false`](#advanced-settings "Jump to Advanced settings") is set
  444. - Use the `alt+right arrow` shortcut on a file entry in the `Changed Files` section to preview the comparison of the current revision with the previous one
  445. - Adds a *Apply Stashed Changes* command (`gitlens.stashApply`) to chose a stash entry to apply to the working tree from a quick pick menu
  446. ---
  447. ### Powerful Comparison Tools
  448. - Effortlessly navigate between comparisons via the `alt+,` and `alt+.` shortcut keys to go back and forth through a file's revisions
  449. - Provides easy access to the following comparison commands via the `Command Palette` as well as in context via the many provided quick pick menus
  450. - Adds a *Directory Compare Working Tree with...* command (`gitlens.diffDirectory`) to open the configured Git difftool to compare the working tree with the selected branch or tag
  451. - Adds a *Compare HEAD with Branch or Tag...* command (`gitlens.diffHeadWithBranch`) to compare the index (HEAD) with the selected branch or tag
  452. - Adds a *Compare Working Tree with Branch or Tag...* command (`gitlens.diffWorkingWithBranch`) to compare the working tree with the selected branch or tag
  453. - Adds a *Compare File with Branch or Tag...* command (`gitlens.diffWithBranch`) to compare the current file with the same file on the selected branch or tag
  454. - Adds a *Compare File with Next Revision* command (`gitlens.diffWithNext`) with a shortcut of `alt+.` to compare the current file/diff with the next commit revision
  455. - Adds a *Compare File with Previous Revision* command (`gitlens.diffWithPrevious`) with a shortcut of `alt+,` to compare the current file/diff with the previous commit revision
  456. - Adds a *Compare Line Revision with Previous* command (`gitlens.diffLineWithPrevious`) with a shortcut of `shift+alt+,` to compare the current file/diff with the previous line commit revision
  457. - Adds a *Compare File with Revision...* command (`gitlens.diffWithRevision`) to compare the current file with the selected revision of the same file
  458. - Adds a *Compare File with Working Revision* command (`gitlens.diffWithWorking`) with a shortcut of `shift+alt+w` to compare the most recent commit revision of the current file/diff with the working tree
  459. - Adds a *Compare Line Revision with Working File* command (`gitlens.diffLineWithWorking`) with a shortcut of `alt+w` to compare the commit revision of the current line with the working tree
  460. ---
  461. ### And More
  462. - Adds a *Copy Commit ID to Clipboard* command (`gitlens.copyShaToClipboard`) to copy the commit id (sha) of the current line to the clipboard or from the most recent commit to the current branch, if there is no current editor
  463. - Adds a *Copy Commit Message to Clipboard* command (`gitlens.copyMessageToClipboard`) to copy the commit message of the current line to the clipboard or from the most recent commit to the current branch, if there is no current editor
  464. - Adds a *Copy Remote File Url to Clipboard* command (`gitlens.copyRemoteFileUrlToClipboard`) to copy the remote url of the current file and line to the clipboard
  465. - Adds a *Open Working File"* command (`gitlens.openWorkingFile`) to open the working file for the current file revision
  466. - Adds a *Open Revision...* command (`gitlens.openFileRevision`) to open the selected revision for the current file
  467. - Adds a *Open Changes (with difftool)* command (`gitlens.externalDiff`) to the source control group and source control resource context menus to open the changes of a file or set of files with the configured git difftool
  468. - Adds a *Open All Changes (with difftool)* command (`gitlens.externalDiffAll`) to open all working changes with the configured git difftool
  469. - Also adds the command to the Source Control group context menu
  470. - Adds a *Open Changed Files* command (`gitlens.openChangedFiles`) to open any files with working tree changes
  471. - Adds a *Close Unchanged Files* command (`gitlens.closeUnchangedFiles`) to close any files without working tree changes
  472. ---
  473. ## GitLens Settings
  474. GitLens is highly customizable and provides many configuration settings to allow the personalization of almost all features.
  475. ### General Settings
  476. |Name | Description
  477. |-----|------------
  478. |`gitlens.defaultDateFormat`|Specifies how absolute dates will be formatted by default<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats
  479. |`gitlens.defaultDateStyle`|Specifies how dates will be displayed by default
  480. |`gitlens.defaultGravatarsStyle`|Specifies the style of the gravatar default (fallback) images<br />`identicon` - a geometric pattern<br />`mm` - a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)<br />`monsterid` - a monster with different colors, faces, etc<br />`retro` - 8-bit arcade-style pixelated faces<br />`robohash` - a robot with different colors, faces, etc<br />`wavatar` - a face with differing features and backgrounds
  481. |`gitlens.insiders`|Specifies whether to enable experimental features
  482. |`gitlens.keymap`|Specifies the keymap to use for GitLens shortcut keys<br />`alternate` - adds an alternate set of shortcut keys that start with `Alt` (&#x2325; on macOS)<br />`chorded` - adds a chorded set of shortcut keys that start with `Ctrl+Shift+G` (<code>&#x2325;&#x2318;G</code> on macOS)<br />`none` - no shortcut keys will be added
  483. |`gitlens.menus`|Specifies which commands will be added to which menus
  484. |`gitlens.outputLevel`|Specifies how much (if any) output will be sent to the GitLens output channel
  485. |`gitlens.settings.mode`|Specifies the display mode of the interactive settings editor<br />`simple` - only displays common settings<br />`advanced` - displays all settings
  486. |`gitlens.showWhatsNewAfterUpgrades`|Specifies whether to show What's New after upgrading to new feature releases
  487. ### GitLens Explorer Settings
  488. See also [Explorer Settings](#explorer-settings "Jump to the Explorer settings")
  489. |Name | Description
  490. |-----|------------
  491. |`gitlens.gitExplorer.autoRefresh`|Specifies whether to automatically refresh the *GitLens* explorer when the repository or the file system changes
  492. |`gitlens.gitExplorer.branches.layout`|Specifies how the *GitLens* explorer will display branches<br />`list` - displays branches as a list<br />`tree` - displays branches as a tree when branch names contain slashes `/`
  493. |`gitlens.gitExplorer.enabled`|Specifies whether to show the *GitLens* explorer"
  494. |`gitlens.gitExplorer.files.compact`|Specifies whether to compact (flatten) unnecessary file nesting in the *GitLens* explorer<br />Only applies when `gitlens.gitExplorer.files.layout` is set to `tree` or `auto`
  495. |`gitlens.gitExplorer.files.layout`|Specifies how the *GitLens* explorer will display files<br />`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.gitExplorer.files.threshold` value and the number of files at each nesting level<br />`list` - displays files as a list<br />`tree` - displays files as a tree
  496. |`gitlens.gitExplorer.files.threshold`|Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the *GitLens* explorer<br />Only applies when `gitlens.gitExplorer.files.layout` is set to `auto`
  497. |`gitlens.gitExplorer.includeWorkingTree`|Specifies whether to include working tree files inside the `Repository Status` node of the *GitLens* explorer
  498. |`gitlens.gitExplorer.location`|Specifies where to show the *GitLens* explorer<br />`gitlens` - adds to the GitLens view<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view
  499. |`gitlens.gitExplorer.showTrackingBranch`|Specifies whether to show the tracking branch when displaying local branches in the *GitLens* explorer"
  500. |`gitlens.gitExplorer.view`|Specifies the starting view of the *GitLens* explorer<br />`auto` - shows the last selected view, defaults to `repository`<br />`history` - shows the commit history of the current file<br />`repository` - shows a repository explorer"
  501. ### GitLens File History Explorer Settings
  502. See also [Explorer Settings](#explorer-settings "Jump to the Explorer settings")
  503. |Name | Description
  504. |-----|------------
  505. |`gitlens.historyExplorer.enabled`|Specifies whether to show the current file history undocked in a *GitLens File History* explorer
  506. |`gitlens.historyExplorer.location`|Specifies where to show the *GitLens File History* explorer<br />`gitlens` - adds to the GitLens view<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view
  507. ### GitLens Results Explorer Settings
  508. See also [Explorer Settings](#explorer-settings "Jump to the Explorer settings")
  509. |Name | Description
  510. |-----|------------
  511. |`gitlens.resultsExplorer.files.compact`|Specifies whether to compact (flatten) unnecessary file nesting in the *GitLens Results* explorer<br />Only applies when `gitlens.resultsExplorer.files.layout` is set to `tree` or `auto`
  512. |`gitlens.resultsExplorer.files.layout`|Specifies how the *GitLens Results* explorer will display files<br />`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.resultsExplorer.files.threshold` value and the number of files at each nesting level<br />`list` - displays files as a list<br />`tree` - displays files as a tree
  513. |`gitlens.resultsExplorer.files.threshold`|Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the *GitLens Results* explorer<br />Only applies when `gitlens.resultsExplorer.files.layout` is set to `auto`
  514. |`gitlens.resultsExplorer.location`|Specifies where to show the *GitLens Results* explorer<br />`gitlens` - adds to the GitLens view<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view
  515. ### Explorer Settings
  516. |Name | Description
  517. |-----|------------
  518. |`gitlens.explorers.avatars`|Specifies whether to show avatar images instead of commit (or status) icons in the *GitLens* and *GitLens Results* explorers
  519. |`gitlens.explorers.commitFileFormat`|Specifies the format of a committed file in the *GitLens* and *GitLens Results* explorers<br />Available tokens<br /> ${directory} - directory name<br /> ${file} - file name<br /> ${filePath} - formatted file name and path<br /> ${path} - full file path
  520. |`gitlens.explorers.commitFormat`|Specifies the format of committed changes in the *GitLens* and *GitLens Results* explorers<br />Available tokens<br /> ${id} - commit id<br /> ${author} - commit author<br /> ${message} - commit message<br /> ${ago} - relative commit date (e.g. 1 day ago)<br /> ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br /> ${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`<br /> ${authorAgo} - commit author, relative commit date<br /> ${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
  521. |`gitlens.explorers.stashFileFormat`|Specifies the format of a stashed file in the *GitLens* and *GitLens Results* explorers<br />Available tokens<br /> ${directory} - directory name<br /> ${file} - file name<br /> ${filePath} - formatted file name and path<br /> ${path} - full file path
  522. |`gitlens.explorers.stashFormat`|Specifies the format of stashed changes in the *GitLens* and *GitLens Results* explorers<br />Available tokens<br /> ${id} - commit id<br /> ${author} - commit author<br /> ${message} - commit message<br /> ${ago} - relative commit date (e.g. 1 day ago)<br /> ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br /> ${agoOrDate} - commit date specified by `gitlens.defaultDateStyle`<br /> ${authorAgo} - commit author, relative commit date<br /> ${authorAgoOrDate} - commit author, commit date specified by `gitlens.defaultDateStyle`<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
  523. |`gitlens.explorers.statusFileFormat`|Specifies the format of the status of a working or committed file in the *GitLens* and *GitLens Results* explorers<br />Available tokens<br /> ${directory} - directory name<br /> ${file} - file name<br /> ${filePath} - formatted file name and path<br /> ${path} - full file path<br />${working} - optional indicator if the file is uncommitted
  524. ### Code Lens Settings
  525. |Name | Description
  526. |-----|------------
  527. |`gitlens.codeLens.authors.command`|Specifies the command to be executed when the `authors` code lens is clicked<br />`gitlens.toggleFileBlame` - toggles file blame annotations<br />`gitlens.diffWithPrevious` - compares the current committed file with the previous commit<br />`gitlens.showQuickCommitDetails` - shows a commit details quick pick<br />`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick<br />`gitlens.showQuickFileHistory` - shows a file history quick pick<br />`gitlens.showQuickRepoHistory` - shows a branch history quick pick
  528. |`gitlens.codeLens.authors.enabled`|Specifies whether to show an `authors` code lens showing number of authors of the file or code block and the most prominent author (if there is more than one)
  529. |`gitlens.codeLens.enabled`|Specifies whether to provide any Git code lens, by default<br />Use the *Toggle Git Code Lens* command (`gitlens.toggleCodeLens`) to toggle the Git code lens on and off for the current window
  530. |`gitlens.codeLens.recentChange.command`|Specifies the command to be executed when the `recent change` code lens is clicked<br />`gitlens.toggleFileBlame` - toggles file blame annotations<br />`gitlens.diffWithPrevious` - compares the current committed file with the previous commit<br />`gitlens.showQuickCommitDetails` - shows a commit details quick pick<br />`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick<br />`gitlens.showQuickFileHistory` - shows a file history quick pick<br />`gitlens.showQuickRepoHistory` - shows a branch history quick pick
  531. |`gitlens.codeLens.recentChange.enabled`|Specifies whether to show a `recent change` code lens showing the author and date of the most recent commit for the file or code block
  532. |`gitlens.codeLens.scopes`|Specifies where Git code lens will be shown in the document<br />`document` - adds code lens at the top of the document<br />`containers` - adds code lens at the start of container-like symbols (modules, classes, interfaces, etc)<br />`blocks` - adds code lens at the start of block-like symbols (functions, methods, etc) lines
  533. |`gitlens.codeLens.scopesByLanguage`|Specifies where Git code lens will be shown in the document for the specified languages
  534. |`gitlens.codeLens.symbolScopes`|Specifies a set of document symbols where Git code lens will or will not be shown in the document<br />Prefix with `!` to not show Git code lens for the symbol<br />Must be a member of [`SymbolKind`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_a-namesymbolkindaspan-classcodeitem-id660symbolkindspan)
  535. #### Current Line Blame Settings
  536. |Name | Description
  537. |-----|------------
  538. |`gitlens.currentLine.dateFormat`|Specifies how to format absolute dates (using the `${date}` token) for the current line blame annotations<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats
  539. |`gitlens.currentLine.enabled`|Specifies whether to provide a blame annotation for the current line, by default<br />Use the *Toggle Line Blame Annotations* command (`gitlens.toggleLineBlame`) to toggle the annotations on and off for the current window
  540. |`gitlens.currentLine.format`|Specifies the format of the current line blame annotation<br />Available tokens<br />`${id}` - commit id<br />`${author}` - commit author<br />`${message}` - commit message<br />`${ago}` - relative commit date (e.g. 1 day ago)<br />`${date}` - formatted commit date (format specified by `gitlens.currentLine.dateFormat`)<br />`${agoOrDate}` - commit date specified by `gitlens.defaultDateStyle`<br />`${authorAgo}` - commit author, relative commit date<br />`${authorAgoOrDate}` - commit author, commit date specified by `gitlens.defaultDateStyle`<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
  541. |`gitlens.currentLine.scrollable`|Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport
  542. ### Gutter Blame Settings
  543. |Name | Description
  544. |-----|------------
  545. |`gitlens.blame.avatars`|Specifies whether to show avatar images in the gutter blame annotations
  546. |`gitlens.blame.compact`|Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations
  547. |`gitlens.blame.dateFormat`|Specifies how to format absolute dates (using the `${date}` token) in gutter blame annotations<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats
  548. |`gitlens.blame.format`|Specifies the format of the gutter blame annotations<br />Available tokens<br />`${id}` - commit id<br />`${author}` - commit author<br />`${message}` - commit message<br />`${ago}` - relative commit date (e.g. 1 day ago)<br />`${date}` - formatted commit date (format specified by `gitlens.blame.dateFormat`)<br />`${agoOrDate}` - commit date specified by `gitlens.defaultDateStyle`<br />`${authorAgo}` - commit author, relative commit date<br />`${authorAgoOrDate}` - commit author, commit date specified by `gitlens.defaultDateStyle`<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
  549. |`gitlens.blame.heatmap.enabled`|Specifies whether to provide a heatmap indicator in the gutter blame annotations
  550. |`gitlens.blame.heatmap.location`|Specifies where the heatmap indicators will be shown in the gutter blame annotations<br />`left` - adds a heatmap indicator on the left edge of the gutter blame annotations<br />`right` - adds a heatmap indicator on the right edge of the gutter blame annotations
  551. |`gitlens.blame.highlight.enabled`|Specifies whether to highlight lines associated with the current line
  552. |`gitlens.blame.highlight.locations`|Specifies where the associated line highlights will be shown<br />`gutter` - adds a gutter glyph<br />`line` - adds a full-line highlight background color<br />`overview` - adds a decoration to the overview ruler (scroll bar)
  553. |`gitlens.blame.ignoreWhitespace`|Specifies whether to ignore whitespace when comparing revisions during blame operations
  554. |`gitlens.blame.separateLines`|Specifies whether gutter blame annotations will have line separators
  555. |`gitlens.blame.toggleMode`|Specifies how the gutter blame annotations will be toggled<br />`file` - toggles each file individually<br />`window` - toggles the window, i.e. all files at once
  556. ### Gutter Heatmap Settings
  557. |Name | Description
  558. |-----|------------
  559. |`gitlens.heatmap.ageThreshold`|Specifies the age of the most recent change (in days) after which the gutter heatmap annotations will be cold rather than hot (i.e. will use `gitlens.heatmap.coldColor` instead of `gitlens.heatmap.hotColor`)
  560. |`gitlens.heatmap.coldColor`|Specifies the base color of the gutter heatmap annotations when the most recent change is older (cold) than the `gitlens.heatmap.ageThreshold` value
  561. |`gitlens.heatmap.hotColor`|Specifies the base color of the gutter heatmap annotations when the most recent change is newer (hot) than the `gitlens.heatmap.ageThreshold` value
  562. |`gitlens.heatmap.toggleMode`|Specifies how the gutter heatmap annotations will be toggled<br />`file` - toggles each file individually<br />`window` - toggles the window, i.e. all files at once
  563. ### Hover Settings
  564. |Name | Description
  565. |-----|------------
  566. |`gitlens.hovers.annotations.changes`|Specifies whether to provide a changes (diff) hover for all lines when showing blame annotations
  567. |`gitlens.hovers.annotations.details`|Specifies whether to provide a commit details hover for all lines when showing blame annotations
  568. |`gitlens.hovers.annotations.enabled`|Specifies whether to provide any hovers when showing blame annotations
  569. |`gitlens.hovers.annotations.over`|Specifies when to trigger hovers when showing blame annotations<br />`annotation` - only shown when hovering over the line annotation<br />`line` - shown when hovering anywhere over the line
  570. |`gitlens.hovers.avatars`|Specifies whether to show avatar images in hovers
  571. |`gitlens.hovers.currentLine.changes`|Specifies whether to provide a changes (diff) hover for the current line
  572. |`gitlens.hovers.currentLine.details`|Specifies whether to provide a commit details hover for the current line
  573. |`gitlens.hovers.currentLine.enabled`|Specifies whether to provide any hovers for the current line
  574. |`gitlens.hovers.currentLine.over`|Specifies when to trigger hovers for the current line<br />`annotation` - only shown when hovering over the line annotation<br />`line` - shown when hovering anywhere over the line
  575. |`gitlens.hovers.enabled`|Specifies whether to provide any hovers
  576. ### Modes Settings
  577. |Name | Description
  578. |-----|------------
  579. |`gitlens.mode.active`|Specifies the active GitLens mode, if any
  580. |`gitlens.mode.statusBar.enabled`|Specifies whether to provide the active GitLens mode on the status bar
  581. |`gitlens.mode.statusBar.alignment`|Specifies the active GitLens mode alignment in the status bar<br />`left` - aligns to the left<br />`right` - aligns to the right
  582. |`gitlens.modes`|Specifies the user-defined GitLens modes
  583. ### Recent Changes Settings
  584. |Name | Description
  585. |-----|------------
  586. |`gitlens.recentChanges.highlight.locations`|Specifies where the highlights of the recently changed lines will be shown<br />`gutter` - adds a gutter glyph<br />`line` - adds a full-line highlight background color<br />`overview` - adds a decoration to the overview ruler (scroll bar)
  587. |`gitlens.recentChanges.toggleMode`|Specifies how the recently changed lines annotations will be toggled<br />`file` - toggles each file individually<br />`window` - toggles the window, i.e. all files at once
  588. ### Status Bar Settings
  589. |Name | Description
  590. |-----|------------
  591. |`gitlens.statusBar.alignment`|Specifies the blame alignment in the status bar<br />`left` - aligns to the left<br />`right` - aligns to the right
  592. |`gitlens.statusBar.command`|Specifies the command to be executed when the blame status bar item is clicked<br />`gitlens.toggleFileBlame` - toggles file blame annotations<br />`gitlens.diffWithPrevious` - compares the current line commit with the previous<br />`gitlens.diffWithWorking` - compares the current line commit with the working tree<br />`gitlens.toggleCodeLens` - toggles Git code lens<br />`gitlens.showQuickCommitDetails` - shows a commit details quick pick<br />`gitlens.showQuickCommitFileDetails` - shows a commit file details quick pick<br />`gitlens.showQuickFileHistory` - shows a file history quick pick<br />`gitlens.showQuickRepoHistory` - shows a branch history quick pick
  593. |`gitlens.statusBar.dateFormat`|Specifies the date format of absolute dates shown in the blame information on the status bar<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats
  594. |`gitlens.statusBar.enabled`|Specifies whether to provide blame information on the status bar
  595. |`gitlens.statusBar.format`|Specifies the format of the blame information on the status bar<br />Available tokens<br />`${id}` - commit id<br />`${author}` - commit author<br />`${message}` - commit message<br />`${ago}` - relative commit date (e.g. 1 day ago)<br />`${date}` - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br />`${agoOrDate}` - commit date specified by `gitlens.defaultDateStyle`<br />`${authorAgo}` - commit author, relative commit date<br />`${authorAgoOrDate}` - commit author, commit date specified by `gitlens.defaultDateStyle`<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
  596. |`gitlens.statusBar.reduceFlicker`|Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing"
  597. ### Advanced Settings
  598. |Name | Description
  599. |-----|------------
  600. |`gitlens.advanced.blame.customArguments`|Specifies additional arguments to pass to the `git blame` command
  601. |`gitlens.advanced.blame.delayAfterEdit`|Specifies the time (in milliseconds) to wait before re-blaming an unsaved document after an edit. Use 0 to specify an infinite wait
  602. |`gitlens.advanced.blame.sizeThresholdAfterEdit`|Specifies the maximum document size (in lines) allowed to be re-blamed after an edit while still unsaved. Use 0 to specify no maximum
  603. |`gitlens.advanced.caching.enabled`|Specifies whether git output will be cached &mdash; changing the default is not recommended
  604. |`gitlens.advanced.git`|Specifies the path to the git executable to use. Use as a last resort as GitLens will use the built-in `git.path` setting first
  605. |`gitlens.advanced.fileHistoryFollowsRenames`|Specifies whether file histories will follow renames -- will affect how merge commits are shown in histories
  606. |`gitlens.advanced.maxListItems`|Specifies the maximum number of items to show in a list. Use 0 to specify no maximum
  607. |`gitlens.advanced.messages`|Specifies which messages should be suppressed
  608. |`gitlens.advanced.quickPick.closeOnFocusOut`|Specifies whether to close QuickPick menus when focus is lost
  609. |`gitlens.advanced.repositorySearchDepth`|Specifies how many folders deep to search for repositories
  610. |`gitlens.advanced.telemetry.enabled`|Specifies whether to enable GitLens telemetry (even if enabled still abides by the overall `telemetry.enableTelemetry` setting
  611. #### Custom Remotes Settings
  612. |Name | Description
  613. |-----|------------
  614. |`gitlens.remotes`|Specifies user-defined remote (code-hosting) services or custom domains for built-in remote services<br /><br />Example:<br />```"gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitHub" }]```<br /><br />Example:<br />```"gitlens.remotes": [{ ```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"domain": "git.corporate-url.com",```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"type": "Custom",```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"name": "My Company", ```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"protocol": "https",```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"urls": {```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"repository": "https://git.corporate-url.com/${repo}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"branches": "https://git.corporate-url.com/${repo}/branches",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"branch": "https://git.corporate-url.com/${repo}/commits/${branch}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"commit": "https://git.corporate-url.com/${repo}/commit/${id}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"file": "https://git.corporate-url.com/${repo}?path=${file}${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileInBranch": "https://git.corporate-url.com/${repo}/blob/${branch}/${file}${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileInCommit": "https://git.corporate-url.com/${repo}/blob/${id}/${file}${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileLine": "#L${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileRange": "#L${start}-L${end}"```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br />&nbsp;&nbsp;&nbsp;&nbsp;```}]```<br /><br />Example:<br />```"gitlens.remotes": [{ ```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"domain": "git.corporate-url.com",```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"type": "Custom",```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"name": "My Company", ```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"protocol": "https",```<br />&nbsp;&nbsp;&nbsp;&nbsp;```"urls": {```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"repository": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"branches": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/branches",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"branch": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/commits/${branch}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"commit": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/commit/${id}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"file": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}?path=${file}${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileInBranch": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/blob/${branch}/${file}${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileInCommit": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/blob/${id}/${file}${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileLine": "#L${line}",```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"fileRange": "#L${start}-L${end}"```<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br />&nbsp;&nbsp;&nbsp;&nbsp;```}]```
  615. #### Strings Settings
  616. |Name | Description
  617. |-----|------------
  618. |`gitlens.strings.codeLens.unsavedChanges.recentChangeAndAuthors`|Specifies the string to be shown in place of both the `recent change` and `authors` code lens when there are unsaved changes
  619. |`gitlens.strings.codeLens.unsavedChanges.recentChangeOnly`|Specifies the string to be shown in place of the `recent change` code lens when there are unsaved changes
  620. |`gitlens.strings.codeLens.unsavedChanges.authorsOnly`|Specifies the string to be shown in place of the `authors` code lens when there are unsaved changes
  621. ---
  622. ## Themable Colors
  623. GitLens defines a set of themable colors which can be provided by vscode themes or directly by the user using [`workbench.colorCustomization`](https://code.visualstudio.com/docs/getstarted/themes#_customize-a-color-theme).
  624. |Name | Description
  625. |-----|------------
  626. |`gitlens.gutterBackgroundColor`|Specifies the background color of the gutter blame annotations
  627. |`gitlens.gutterForegroundColor`|Specifies the foreground color of the gutter blame annotations
  628. |`gitlens.gutterUncommittedForegroundColor`|Specifies the foreground color of an uncommitted line in the gutter blame annotations
  629. |`gitlens.trailingLineBackgroundColor`|Specifies the background color of the trailing blame annotation
  630. |`gitlens.trailingLineForegroundColor`|Specifies the foreground color of the trailing blame annotation
  631. |`gitlens.lineHighlightBackgroundColor`|Specifies the background color of the associated line highlights in blame annotations
  632. |`gitlens.lineHighlightOverviewRulerColor`|Specifies the overview ruler color of the associated line highlights in blame annotations
  633. ---
  634. ## Insiders
  635. Add [`"gitlens.insiders": true`](#general-settings "Jump to GitLens settings") to your settings to join the insiders channel and get early access to upcoming features. Be aware that because this provides early access expect there to be issues.
  636. ---
  637. ## Contributors &#x1F64F;&#x2764;
  638. A big thanks to the people that have contributed to this project:
  639. - Amanda Cameron ([@AmandaCameron](https://github.com/AmandaCameron)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=AmandaCameron)
  640. - Brett Cannon ([@brettcannon](https://github.com/brettcannon)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=brettcannon)
  641. - Segev Finer ([@segevfiner](https://github.com/segevfiner)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=segevfiner)
  642. - Cory Forsyth ([@bantic](https://github.com/bantic)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=bantic)
  643. - Geoffrey ([@g3offrey](https://github.com/g3offrey)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=g3offrey)
  644. - Yukai Huang ([@Yukaii](https://github.com/Yukaii)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=Yukaii)
  645. - Roy Ivy III ([@rivy](https://github.com/rivy)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=rivy)
  646. - Helmut Januschka ([@hjanuschka](https://github.com/hjanuschka)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=hjanuschka)
  647. - Chris Kaczor ([@ckaczor](https://github.com/ckaczor)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=ckaczor)
  648. - korigod ([@korigod](https://github.com/korigod)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=korigod)
  649. - Peng Lyu ([@rebornix](https://github.com/rebornix)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=rebornix)
  650. - Cédric Malard ([@cmalard](https://github.com/cmalard)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=cmalard)
  651. - Aurelio Ogliari ([@nobitagit](https://github.com/nobitagit)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=nobitagit)
  652. - Maxim Pekurin ([@pmaxim25](https://github.com/pmaxim25)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=pmaxim25)
  653. - Johannes Rieken ([@jrieken](https://github.com/jrieken)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=jrieken)
  654. - ryenus ([@ryenus](https://github.com/ryenus)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=ryenus)
  655. - Zack Schuster ([@zackschuster](https://github.com/zackschuster)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=zackschuster)
  656. - SpaceEEC ([@SpaceEEC](https://github.com/SpaceEEC)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=SpaceEEC)
  657. - Alexey Vasyukov ([@notmedia](https://github.com/notmedia)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=notmedia)
  658. - Zyck ([@qzyse2017](https://github.com/qzyse2017)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=qzyse2017)
  659. Also special thanks to the people that have provided support, testing, brainstorming, etc:
  660. - Brian Canzanella ([@bcanzanella](https://github.com/bcanzanella))
  661. - Matt King ([@KattMingMing](https://github.com/KattMingMing))
  662. And of course the awesome [vscode](https://github.com/Microsoft/vscode/graphs/contributors) team!