Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

870 rindas
114 KiB

pirms 7 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
  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/develop/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. https://raw.githubusercontent.com/eamodio/vscode-gitlens/blob/cd90faa526720cb4b07a52b3cf84abaa55a978a0/images/cl-heatmap-cold.png
  12. # What's new in GitLens 9
  13. ## 9.0 &mdash; September 2018
  14. See the [release notes](https://github.com/eamodio/vscode-gitlens/blob/master/CHANGELOG.md 'Open Release Notes') for the full set of changes
  15. # GitLens
  16. [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').
  17. While GitLens is generously offered to everyone free of charge, if you find it useful please consider [supporting](#support-gitlens 'Support GitLens') it.
  18. 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.
  19. Here are just some of the features that GitLens provides,
  20. - a [_Repositories_ explorer](#repositories-explorer 'Jump to the Repositories explorer') to visualize, navigate, and explore Git repositories
  21. - a [_File History_ explorer](#file-history-explorer 'Jump to the File History explorer') to visualize, navigate, and explore the revision history of the current file
  22. - a [_Line History_ explorer](#line-history-explorer 'Jump to the Line History explorer') to visualize, navigate, and explore the revision history of the selected lines of current file
  23. - an on-demand [_Results_ explorer](#results-explorer 'Jump to the Results explorer') to navigate and explore commits, histories, and searches, or visualize comparisons between branches, tags, commits, and more
  24. - [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
  25. - an unobtrusive [current line blame](#current-line-blame 'Jump to the Current Line Blame') annotation at the end of the line
  26. - on-demand [gutter blame](#gutter-blame 'Jump to the Gutter Blame') annotations, including a heatmap, for the whole file
  27. - 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)
  28. - detailed blame information accessible via [hovers](#hovers 'Jump to Hovers)
  29. - on-demand [recent changes](#recent-changes 'Jump to the Recent Changes') annotations to highlight lines changed by the most recent commit
  30. - a [status bar blame](#status-bar-blame 'Jump to the Status Bar Blame') annotation showing author and date for the current line
  31. - [commit search](#commit-search 'Jump to the Commit Search') &mdash; by message, author, filename, commit id, or code changes
  32. - many powerful commands for exploring commits and histories, comparing and navigating revisions, stash access, repository status, etc
  33. - and so much [more](#features 'Jump to Features')
  34. 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').
  35. <p align="center">
  36. <br />
  37. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/gitlens-preview.gif" alt="GitLens Preview" />
  38. <br />
  39. </p>
  40. ## Support GitLens
  41. While GitLens is generously offered to everyone free of charge, if you find it useful please consider supporting it.
  42. 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.
  43. 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.
  44. While I enjoy giving my free time and attention to GitLens' development and growth, I would like to do even more.
  45. ### Show Your Support &#x2764;
  46. 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.
  47. If you'd like to join them in supporting GitLens, please consider the following &mdash; feel free to choose more than one. &#x1F609;
  48. - [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)
  49. - [Donations via PayPal](https://www.paypal.me/eamodio 'One-time donations via PayPal')
  50. - [Donations via Cash App](https://cash.me/$eamodio 'One-time donations via Cash App')
  51. - [Write a Review](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens#review-details 'Write a review')
  52. - [Star or Fork me on GitHub](https://github.com/eamodio/vscode-gitlens 'Star or fork me on GitHub')
  53. - [Follow me on Twitter](https://twitter.com/eamodio 'Follow me on Twitter')
  54. #### Gold Sponsors ($300+)
  55. None yet &mdash; could be you!
  56. #### Silver Sponsors ($150+)
  57. None yet &mdash; could be you!
  58. #### Bronze Sponsors ($50+)
  59. - Michael Duffy
  60. ## Configuration
  61. <p align="center">
  62. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/settings.png" alt="GitLens Interactive Settings" />
  63. </p>
  64. 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).
  65. For more advanced customizations, refer to the [settings documentation](#gitlens-settings 'Jump to the GitLens settings docs') below.
  66. ## Features
  67. ### Repositories Explorer
  68. <p align="center">
  69. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/repositories-explorer.png" alt="Repositories Explorer" />
  70. </p>
  71. A [customizable](#repositories-explorer-settings 'Jump to the Repositories explorer settings') explorer to visualize, navigate, and explore Git repositories.
  72. - A toolbar provides _Search Commits_, and _Refresh_ commands
  73. - A context menu provides _Automatic Layout_, _List Layout_, _Tree Layout_, and _Enable Automatic Refresh_ or _Disable Automatic Refresh_ commands
  74. The repositories explorer provides the following features,
  75. - **Repository Status**
  76. - Provides the name of the current branch, [optionally](#repositories-explorer-settings 'Jump to the Repositories explorer settings') its working tree status, and its upstream tracking branch and status (if available)
  77. - Provides indicator dots on the repository icon which denote the following:
  78. - _None_ &mdash; up-to-date with the upstream
  79. - _Green_ &mdash; ahead of the upstream
  80. - _Red_ &mdash; behind the upstream
  81. - _Yellow_ &mdash; both ahead of and behind the upstream
  82. - Provides additional upstream status nodes, if the current branch is tracking a remote branch and,
  83. - is behind the upstream &mdash; quickly see and explore the specific commits behind the upstream (i.e. commits that haven't been pulled)
  84. - 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)
  85. - A context menu provides _Open Repository in Remote_, and _Refresh_ commands
  86. - **Changed Files** &mdash; lists all the "working" changes
  87. - Expands to a file-based view of all changed files in the working tree ([optionally](#repositories-explorer-settings 'Jump to the Repositories explorer settings')) and/or all files in all commits ahead of the upstream
  88. - **History (current-branch)** &mdash; lists the revision (commit) history of the current branch
  89. - See the _Branches expand_ section under **Branches** below for more details
  90. - **Branches** &mdash; lists the local branches
  91. - Indicates which branch is the current branch and [optionally](#repositories-explorer-settings 'Jump to the Repositories explorer settings') shows the remote tracking branch
  92. - A context menu provides _Open Branches in Remote_, and _Refresh_ commands
  93. - Branches expand to show its revision (commit) history
  94. - Provides indicator dots on each branch icon which denote the following:
  95. - _None_ &mdash; no upstream or up-to-date with the upstream
  96. - _Green_ &mdash; ahead of the upstream
  97. - _Red_ &mdash; behind the upstream
  98. - _Yellow_ &mdash; both ahead of and behind the upstream
  99. - Context menus for each branch provide
  100. - _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
  101. - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  102. - Context menus for each revision (commit) provide
  103. - _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
  104. - Context menus for each changed file provide
  105. - _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
  106. - Inline toolbars for each changed file provide an _Open File_ command
  107. - **Remotes** &mdash; lists the remotes
  108. - Indicates the direction of the remote (fetch, push, both), remote service (if applicable), and repository path
  109. - A context menu provides a _Refresh_ command
  110. - Remotes expands show its list of branches
  111. - Context menus for each remote provide
  112. - _Open Branches in Remote_, _Open Repository in Remote_, _Remove Remote (via Terminal)_, and _Refresh_ commands
  113. - Branches expand to show its revision (commit) history
  114. - See the _Branches expand_ section under **Branches** above for more details
  115. - **Stashes** &mdash; lists the stashed changes
  116. - A context menu provides _Stash Changes_, and _Refresh_ commands
  117. - Stashes expand to show the set of files stashed, complete with status indicators for adds, changes, renames, and deletes
  118. - Context menus for each stash provide
  119. - _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
  120. - Context menus for each stashed file provide
  121. - _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
  122. - **Tags** &mdash; lists the tags
  123. - A context menu provides a _Refresh_ command
  124. - Tags expand to show its revision (commit) history
  125. - Context menus for each tag provide
  126. - _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
  127. - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  128. - See the _Revisions (commits) expand_ section under **Branches** above for more details
  129. ---
  130. ### File History Explorer
  131. <p align="center">
  132. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/file-history-explorer.png" alt="File History Explorer" />
  133. </p>
  134. A [customizable](#file-history-explorer-settings 'Jump to the File History explorer settings') explorer to visualize, navigate, and explore the revision history of the current file.
  135. - A toolbar provides a _Refresh_ command
  136. - A context menu provides a _Follow Renames_ or _Don't Follow Renames_ command
  137. The file history explorer provides the following features,
  138. - Automatically updates to track the current editor
  139. - A context menu provides _Open File_, _Open File in Remote_ (if available), _Copy Remote File Url to Clipboard_ (if available), and _Refresh_ commands
  140. - An inline toolbar provides an _Open File_ command
  141. - Context menus for each revision (commit) provides
  142. - _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
  143. ---
  144. ### Line History Explorer
  145. <p align="center">
  146. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/line-history-explorer.png" alt="Line History Explorer" />
  147. </p>
  148. A [customizable](#line-history-explorer-settings 'Jump to the Line History explorer settings') explorer to visualize, navigate, and explore the revision history of the selected lines of current file.
  149. - A toolbar provides a _Refresh_ command
  150. - A context menu provides a _Follow Renames_ or _Don't Follow Renames_ command
  151. The line history explorer provides the following features,
  152. - Automatically updates to track the selection of the current editor
  153. - A context menu provides _Open File_, _Open File in Remote_ (if available), _Copy Remote File Url to Clipboard_ (if available), and _Refresh_ commands
  154. - An inline toolbar provides an _Open File_ command
  155. - Context menus for each revision (commit) provides
  156. - _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
  157. ---
  158. ### Results Explorer
  159. <p align="center">
  160. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/results-explorer.png" alt="Results explorer" />
  161. </p>
  162. An on-demand, [customizable](#results-explorer-settings 'Jump to the Results explorer settings') explorer to navigate and explore commits, histories, and searches, or visualize comparisons between branches, tags, commits, and more
  163. - A toolbar provides _Search Commits_, _Keep Results_, and _Refresh_ commands
  164. - A context menu provides _Automatic Layout_, _List Layout_, _Tree Layout_, and _Close_ commands
  165. The results explorer provides the following features,
  166. #### Explore
  167. - Provides a semi-persistent results view for exploring histories, commits, and searches
  168. - Accessible via the following commands
  169. - _Show Commit Search_ command (`gitlens.showCommitSearch`)
  170. - _Show File History_ command (`gitlens.showQuickFileHistory`)
  171. - _Show Commit Details_ command (`gitlens.showQuickCommitDetails`)
  172. - An inline toolbar provides a _Clear Results_ command
  173. - A context menu provides _Clear Results_, and _Refresh_ commands
  174. - Revisions (commits) expand show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  175. - Context menus for each revision (commit) provide
  176. - _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
  177. - Context menus for each changed file provide
  178. - _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
  179. #### Compare
  180. - Provides a semi-persistent results view for comparison operations
  181. - Accessible via the following commands
  182. - _Compare with Remote_ command (`gitlens.explorers.compareWithRemote`)
  183. - _Compare with HEAD_ command (`gitlens.explorers.compareWithHead`)
  184. - _Compare with Working Tree_ command (`gitlens.explorers.compareWithWorking`)
  185. - _Compare with Selected_ command (`gitlens.explorers.compareWithSelected`)
  186. - _Compare Ancestry with Working Tree_ command (`gitlens.explorers.compareAncestryWithWorking`)
  187. - An inline toolbar provides _Swap Comparision_, and _Clear Results_ commands
  188. - A context menu provides _Clear Results_, _Swap Comparision_, _Open Directory Compare_, and _Refresh_ commands
  189. - **Commits** &mdash; lists the commits between the compared revisions (branches or commits)
  190. - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
  191. - See the _Revisions (commits) expand_ section under **Explore** above for more details
  192. - **Changed Files** &mdash; lists the files changed between the compared revisions (branches or commits)
  193. - Expands to a file-based view of all changed files
  194. - Context menus for each changed file provide
  195. - _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
  196. ---
  197. ### Code Lens
  198. <p align="center">
  199. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/code-lens.png" alt="Code Lens" />
  200. </p>
  201. - 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)
  202. - **Recent Change** &mdash; author and date of the most recent commit for the file or code block
  203. - 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'))
  204. - **Authors** &mdash; number of authors of the file or code block and the most prominent author (if there is more than one)
  205. - 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'))
  206. - 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
  207. - Provides [customizable](#code-lens-settings 'Jump to the Code Lens settings') click behavior for each code lens &mdash; choose between one of the following
  208. - Toggle file blame annotations on and off
  209. - Compare the commit with the previous commit
  210. - Show a quick pick menu with details and commands for the commit
  211. - Show a quick pick menu with file details and commands for the commit
  212. - Show a quick pick menu with the commit history of the file
  213. - Show a quick pick menu with the commit history of the current branch
  214. - Adds a _Toggle Git Code Lens_ command (`gitlens.toggleCodeLens`) with a shortcut of `shift+alt+b` to toggle the code lens on and off
  215. ---
  216. ### Current Line Blame
  217. <p align="center">
  218. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/current-line-blame.png" alt="Current Line Blame" />
  219. </p>
  220. - 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
  221. - 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'))
  222. - Adds a _Toggle Line Blame Annotations_ command (`gitlens.toggleLineBlame`) to toggle the blame annotation on and off
  223. ---
  224. ### Gutter Blame
  225. <p align="center">
  226. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/gutter-blame.png" alt="Gutter Blame">
  227. </p>
  228. - 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
  229. - Contains the commit message and date, by [default](#gutter-blame-settings 'Jump to the Gutter Blame settings')
  230. - 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)
  231. - See the [gutter heatmap](#gutter-Heatmap 'Jump to the Gutter Heatmap') section below for more details
  232. - Adds a _Toggle File Blame Annotations_ command (`gitlens.toggleFileBlame`) with a shortcut of `alt+b` to toggle the blame annotations on and off
  233. - Press `Escape` to turn off the annotations
  234. ---
  235. ### Gutter Heatmap
  236. <p align="center">
  237. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/heatmap.png" alt="Gutter Heatmap" />
  238. </p>
  239. - Adds an on-demand **heatmap** to the edge of the gutter to show how recently lines were changed
  240. - 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'))
  241. - 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
  242. - Adds _Toggle File Heatmap Annotations_ command (`gitlens.toggleFileHeatmap`) to toggle the heatmap on and off
  243. - Press `Escape` to turn off the annotations
  244. ---
  245. ### Hovers
  246. #### Current Line Hovers
  247. <p align="center">
  248. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/hovers-current-line.png" alt="Current Line Hovers" />
  249. </p>
  250. - Adds [customizable](#hover-settings 'Jump to the Hover settings') Git blame hovers accessible over the current line
  251. ##### Details Hover
  252. <p align="center">
  253. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/hovers-current-line-details.png" alt="Current Line Details Hover" />
  254. </p>
  255. - 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)
  256. - Provides automatic issue linking to Bitbucket, GitHub, GitLab, and Visual Studio Team Services in commit messages
  257. - Provides a **quick-access command bar** with _Open Changes_, _Blame Previous Revision_, _Open in Remote_, and _Show More Actions_ command buttons
  258. - Click the commit id to execute the _Show Commit Details_ command
  259. ##### Changes (diff) Hover
  260. <p align="center">
  261. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/hovers-current-line-changes.png" alt="Current Line Changes (diff) Hover" />
  262. </p>
  263. - 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)
  264. - Click the **Changes** to execute the _Open Changes_ command
  265. - Click the current and previous commit ids to execute the _Show Commit Details_ command
  266. #### Annotation Hovers
  267. <p align="center">
  268. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/hovers-annotations.png" alt="Annotation Hovers" />
  269. </p>
  270. - Adds [customizable](#hover-settings 'Jump to the Hover settings') Git blame hovers accessible when annotating
  271. ##### Details Hover
  272. <p align="center">
  273. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/hovers-annotations-details.png" alt="Annotations Details Hover" />
  274. </p>
  275. - 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)
  276. - Provides automatic issue linking to Bitbucket, GitHub, GitLab, and Visual Studio Team Services in commit messages
  277. - Provides a **quick-access command bar** with _Open Changes_, _Blame Previous Revision_, _Open in Remote_, and _Show More Actions_ command buttons
  278. - Click the commit id to execute the _Show Commit Details_ command
  279. ##### Changes (diff) Hover
  280. <p align="center">
  281. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/hovers-annotations-changes.png" alt="Annotations Changes (diff) Hover" />
  282. </p>
  283. - 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)
  284. - Click the **Changes** to execute the _Open Changes_ command
  285. - Click the current and previous commit ids to execute the _Show Commit Details_ command
  286. ---
  287. ### Modes
  288. - GitLens supports [user-defined](#modes-settings 'Jump to the Modes settings') modes for quickly toggling between sets of settings
  289. - Adds _Switch Mode_ command (`gitlens.switchMode`) to quickly switch the active mode
  290. - Adds a built-in _Zen_ mode which for a zen-like experience, disables many visual features
  291. - Adds _Toggle Zen Mode_ command (`gitlens.toggleZenMode`) to toggle Zen mode
  292. - Adds a built-in _Review_ mode which for reviewing code, enables many visual features
  293. - Adds _Toggle Review Mode_ command (`gitlens.toggleReviewMode`) to toggle Review mode
  294. - Adds the active mode to the **status bar** ([optional](#modes-settings 'Jump to the Modes settings'), on by default)
  295. ---
  296. ### Recent Changes
  297. <p align="center">
  298. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/recent-changes.png" alt="Recent Changes" />
  299. </p>
  300. - 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
  301. - Adds _Toggle Recent File Changes Annotations_ command (`gitlens.toggleFileRecentChanges`) to toggle the recent changes annotations on and off
  302. - Press `Escape` to turn off the annotations
  303. ---
  304. ### Status Bar Blame
  305. <p align="center">
  306. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/status-bar.png" alt="Status Bar Blame" />
  307. </p>
  308. - 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)
  309. - Contains the commit author and date (by [default](#status-bar-settings 'Jump to the Status Bar Blame settings'))
  310. - 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'))
  311. - Provides [customizable](#status-bar-settings 'Jump to the Status Bar Blame settings') click behavior &mdash; choose between one of the following
  312. - Toggle file blame annotations on and off
  313. - Toggle code lens on and off
  314. - Compare the line commit with the previous commit
  315. - Compare the line commit with the working tree
  316. - Show a quick pick menu with details and commands for the commit (default)
  317. - Show a quick pick menu with file details and commands for the commit
  318. - Show a quick pick menu with the commit history of the file
  319. - Show a quick pick menu with the commit history of the current branch
  320. ---
  321. ### Commit Search
  322. - 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
  323. - 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')
  324. - 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')
  325. - 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')
  326. - 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')
  327. - 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')
  328. - 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')
  329. - Provides a _Show in Results_ option to show the search results in the _Results_ explorer
  330. ---
  331. ### Navigate and Explore
  332. - 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
  333. - 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
  334. - 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**
  335. - _Open Branches in Remote_ command (`gitlens.openBranchesInRemote`) &mdash; opens the branches in the supported remote service
  336. - _Open Branch in Remote_ command (`gitlens.openBranchInRemote`) &mdash; opens the current branch commits in the supported remote service
  337. - _Open Commit in Remote_ command (`gitlens.openCommitInRemote`) &mdash; opens the commit revision of the current line in the supported remote service
  338. - _Open File in Remote_ command (`gitlens.openFileInRemote`) &mdash; opens the current file/revision in the supported remote service
  339. - _Open Repository in Remote_ command (`gitlens.openRepoInRemote`) &mdash; opens the repository in the supported remote service
  340. #### Branch History
  341. <p align="center">
  342. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/menu-branch-history.png" alt="Branch History Quick Pick Menu" />
  343. </p>
  344. - 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
  345. - Provides entries to _Show Commit Search_ and _Open Branch in \<remote-service\>_ when available
  346. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  347. - Navigate pages via `alt+,` and `alt+.` to go backward and forward respectively
  348. - 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
  349. - Provides the same features as _Show Current Branch History_ above
  350. #### File History
  351. <p align="center">
  352. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/menu-file-history.png" alt="File History Quick Pick Menu" />
  353. </p>
  354. - 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
  355. - Provides additional entries to _Show in Results_, _Show Branch History_, and _Open File in \<remote-service\>_ when available
  356. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  357. - Navigate pages via `alt+,` and `alt+.` to go backward and forward respectively
  358. #### Commit Details
  359. <p align="center">
  360. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/menu-commit-details.png" alt="Commit Details Quick Pick Menu" />
  361. </p>
  362. - 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
  363. - Quickly see the set of files changed in the commit, complete with status indicators for adds, changes, renames, and deletes
  364. - 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_
  365. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  366. - 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
  367. - 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
  368. <p align="center">
  369. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/menu-commit-file-details.png" alt="Commit File Details Quick Pick Menu" />
  370. </p>
  371. - 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
  372. - 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_
  373. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  374. - 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
  375. #### Repository Status
  376. <p align="center">
  377. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/menu-repo-status.png" alt="Repository Status Quick Pick Menu" />
  378. </p>
  379. - 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
  380. - Quickly see upstream status (if an Git upstream is configured) &mdash; complete with ahead and behind information
  381. - 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
  382. - 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
  383. - Quickly see all working changes, both staged and unstaged, complete with status indicators for adds, changes, renames, and deletes
  384. - Provides entries to _Show Stashed Changes_, _Open Changed Files_, and _Close Unchanged Files_
  385. - 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
  386. - 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
  387. #### Stashes
  388. <p align="center">
  389. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/menu-stash-list.png" alt="Stashed Changes Quick Pick Menu" />
  390. </p>
  391. - Adds a _Show Stashed Changes_ command (`gitlens.showQuickStashList`) to show a **stashed changes quick pick menu** for exploring your repository stash history
  392. - Provides additional entries to _Stash Changes_
  393. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  394. - Adds a _Stash Changes_ command (`gitlens.stashSave`) to save any working tree changes to the stash &mdash; can optionally provide a stash message
  395. - Also adds the command to the Source Control items context menu to stash an individual or group of files, works with multi-select too!
  396. #### Stash Details
  397. <p align="center">
  398. <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/menu-stash-details.png" alt="Stash Details Quick Pick Menu" />
  399. </p>
  400. - Stashed changes show a **stash details quick pick menu** which is very similar to the **commit details quick pick menu** above
  401. - Quickly see the set of files changed in the stash, complete with status indicators for adds, changes, renames, and deletes
  402. - 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_
  403. - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
  404. - 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
  405. - 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
  406. - Adds a _Apply Stashed Changes_ command (`gitlens.stashApply`) to chose a stash entry to apply to the working tree from a quick pick menu
  407. ---
  408. ### Powerful Comparison Tools
  409. - Effortlessly navigate between comparisons via the `alt+,` and `alt+.` shortcut keys to go back and forth through a file's revisions
  410. - Provides easy access to the following comparison commands via the `Command Palette` as well as in context via the many provided quick pick menus
  411. - 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
  412. - Adds a _Compare HEAD with Branch or Tag..._ command (`gitlens.diffHeadWithBranch`) to compare the index (HEAD) with the selected branch or tag
  413. - Adds a _Compare Working Tree with Branch or Tag..._ command (`gitlens.diffWorkingWithBranch`) to compare the working tree with the selected branch or tag
  414. - Adds a _Open Changes with Branch or Tag..._ command (`gitlens.diffWithBranch`) to compare the current file with the same file on the selected branch or tag
  415. - Adds a _Open Changes with Next Revision_ command (`gitlens.diffWithNext`) with a shortcut of `alt+.` to compare the current file/diff with the next commit revision
  416. - Adds a _Open Changes with Previous Revision_ command (`gitlens.diffWithPrevious`) with a shortcut of `alt+,` to compare the current file/diff with the previous commit revision
  417. - Adds a _Open Line Changes with Previous Revision_ command (`gitlens.diffLineWithPrevious`) with a shortcut of `shift+alt+,` to compare the current file/diff with the previous line commit revision
  418. - Adds a _Open Changes with Revision..._ command (`gitlens.diffWithRevision`) to compare the current file with the selected revision of the same file
  419. - Adds a _Open Changes with Working File_ 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
  420. - Adds a _Open Line Changes 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
  421. ---
  422. ### And More
  423. - 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
  424. - 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
  425. - 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
  426. - Adds a _Open Working File"_ command (`gitlens.openWorkingFile`) to open the working file for the current file revision
  427. - Adds a _Open Revision..._ command (`gitlens.openFileRevision`) to open the selected revision for the current file
  428. - 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
  429. - Adds a _Open All Changes (with difftool)_ command (`gitlens.externalDiffAll`) to open all working changes with the configured git difftool
  430. - Also adds the command to the Source Control group context menu
  431. - Adds a _Open Changed Files_ command (`gitlens.openChangedFiles`) to open any files with working tree changes
  432. - Adds a _Close Unchanged Files_ command (`gitlens.closeUnchangedFiles`) to close any files without working tree changes
  433. ---
  434. ## GitLens Settings
  435. GitLens is highly customizable and provides many configuration settings to allow the personalization of almost all features.
  436. ### General Settings
  437. | Name | Description |
  438. | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  439. | `gitlens.defaultDateFormat` | Specifies how absolute dates will be formatted by default<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats |
  440. | `gitlens.defaultDateStyle` | Specifies how dates will be displayed by default |
  441. | `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 |
  442. | `gitlens.insiders` | Specifies whether to enable experimental features |
  443. | `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 |
  444. | `gitlens.menus` | Specifies which commands will be added to which menus |
  445. | `gitlens.outputLevel` | Specifies how much (if any) output will be sent to the GitLens output channel |
  446. | `gitlens.settings.mode` | Specifies the display mode of the interactive settings editor<br />`simple` - only displays common settings<br />`advanced` - displays all settings |
  447. | `gitlens.showWhatsNewAfterUpgrades` | Specifies whether to show What's New after upgrading to new feature releases |
  448. ### Repositories Explorer Settings
  449. See also [Explorer Settings](#explorer-settings 'Jump to the Explorer settings')
  450. | Name | Description |
  451. | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  452. | `gitlens.repositoriesExplorer.autoRefresh` | Specifies whether to automatically refresh the _Repositories_ explorer when the repository or the file system changes |
  453. | `gitlens.repositoriesExplorer.autoReveal` | Specifies whether to automatically reveal repositories in the _Repositories_ explorer when opening files |
  454. | `gitlens.repositoriesExplorer.branches.layout` | Specifies how the _Repositories_ explorer will display branches<br />`list` - displays branches as a list<br />`tree` - displays branches as a tree when branch names contain slashes `/` |
  455. | `gitlens.repositoriesExplorer.enabled` | Specifies whether to show the _Repositories_ explorer |
  456. | `gitlens.repositoriesExplorer.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Repositories_ explorer<br />Only applies when `gitlens.repositoriesExplorer.files.layout` is set to `tree` or `auto` |
  457. | `gitlens.repositoriesExplorer.files.layout` | Specifies how the _Repositories_ explorer will display files<br />`auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.repositoriesExplorer.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 |
  458. | `gitlens.repositoriesExplorer.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 _Repositories_ explorer<br />Only applies when `gitlens.repositoriesExplorer.files.layout` is set to `auto` |
  459. | `gitlens.repositoriesExplorer.includeWorkingTree` | Specifies whether to include working tree files inside the `Repository Status` node of the _Repositories_ explorer |
  460. | `gitlens.repositoriesExplorer.location` | Specifies where to show the _Repositories_ explorer<br />`gitlens` - adds to the GitLens view<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view |
  461. | `gitlens.repositoriesExplorer.showTrackingBranch` | Specifies whether to show the tracking branch when displaying local branches in the _Repositories_ explorer |
  462. ### File History Explorer Settings
  463. See also [Explorer Settings](#explorer-settings 'Jump to the Explorer settings')
  464. | Name | Description |
  465. | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  466. | `gitlens.fileHistoryExplorer.avatars` | Specifies whether to show avatar images instead of status icons in the _File History_ explorer |
  467. | `gitlens.fileHistoryExplorer.enabled` | Specifies whether to show the _File History_ explorer |
  468. | `gitlens.fileHistoryExplorer.location` | Specifies where to show the _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 |
  469. ### Line History Explorer Settings
  470. See also [Explorer Settings](#explorer-settings 'Jump to the Explorer settings')
  471. | Name | Description |
  472. | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  473. | `gitlens.lineHistoryExplorer.avatars` | Specifies whether to show avatar images instead of status icons in the _Line History_ explorer |
  474. | `gitlens.lineHistoryExplorer.enabled` | Specifies whether to show the _Line History_ explorer |
  475. | `gitlens.lineHistoryExplorer.location` | Specifies where to show the _Line History_ explorer<br />`gitlens` - adds to the GitLens view<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view |
  476. ### Results Explorer Settings
  477. See also [Explorer Settings](#explorer-settings 'Jump to the Explorer settings')
  478. | Name | Description |
  479. | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  480. | `gitlens.resultsExplorer.files.compact` | Specifies whether to compact (flatten) unnecessary file nesting in the _Results_ explorer<br />Only applies when `gitlens.resultsExplorer.files.layout` is set to `tree` or `auto` |
  481. | `gitlens.resultsExplorer.files.layout` | Specifies how the _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 |
  482. | `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 _Results_ explorer<br />Only applies when `gitlens.resultsExplorer.files.layout` is set to `auto` |
  483. | `gitlens.resultsExplorer.location` | Specifies where to show the _Results_ explorer<br />`gitlens` - adds to the GitLens view<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view |
  484. ### Explorer Settings
  485. | Name | Description |
  486. | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  487. | `gitlens.explorers.avatars` | Specifies whether to show avatar images instead of commit (or status) icons in the _Repositories_ and _Results_ explorers |
  488. | `gitlens.explorers.commitFileFormat` | Specifies the format of a committed file in the _Repositories_ and _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 |
  489. | `gitlens.explorers.commitFormat` | Specifies the format of committed changes in the _Repositories_ and _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 |
  490. | `gitlens.explorers.defaultItemLimit` | Specifies the default number of items to show in an explorer list. Use 0 to specify no limit |
  491. | `gitlens.explorers.stashFileFormat` | Specifies the format of a stashed file in the _Repositories_ and _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 |
  492. | `gitlens.explorers.stashFormat` | Specifies the format of stashed changes in the _Repositories_ and _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 |
  493. | `gitlens.explorers.statusFileFormat` | Specifies the format of the status of a working or committed file in the _Repositories_ explorer<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 |
  494. ### Code Lens Settings
  495. | Name | Description |
  496. | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  497. | `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 |
  498. | `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) |
  499. | `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 |
  500. | `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 |
  501. | `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 |
  502. | `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 |
  503. | `gitlens.codeLens.scopesByLanguage` | Specifies where Git code lens will be shown in the document for the specified languages |
  504. | `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) |
  505. #### Current Line Blame Settings
  506. | Name | Description |
  507. | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  508. | `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 |
  509. | `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 |
  510. | `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 |
  511. | `gitlens.currentLine.scrollable` | Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport |
  512. ### Gutter Blame Settings
  513. | Name | Description |
  514. | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  515. | `gitlens.blame.avatars` | Specifies whether to show avatar images in the gutter blame annotations |
  516. | `gitlens.blame.compact` | Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations |
  517. | `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 |
  518. | `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 |
  519. | `gitlens.blame.heatmap.enabled` | Specifies whether to provide a heatmap indicator in the gutter blame annotations |
  520. | `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 |
  521. | `gitlens.blame.highlight.enabled` | Specifies whether to highlight lines associated with the current line |
  522. | `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) |
  523. | `gitlens.blame.ignoreWhitespace` | Specifies whether to ignore whitespace when comparing revisions during blame operations |
  524. | `gitlens.blame.separateLines` | Specifies whether gutter blame annotations will have line separators |
  525. | `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 |
  526. ### Gutter Heatmap Settings
  527. | Name | Description |
  528. | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  529. | `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`) |
  530. | `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 |
  531. | `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 |
  532. | `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 |
  533. ### Hover Settings
  534. | Name | Description |
  535. | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  536. | `gitlens.hovers.annotations.changes` | Specifies whether to provide a changes (diff) hover for all lines when showing blame annotations |
  537. | `gitlens.hovers.annotations.details` | Specifies whether to provide a commit details hover for all lines when showing blame annotations |
  538. | `gitlens.hovers.annotations.enabled` | Specifies whether to provide any hovers when showing blame annotations |
  539. | `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 |
  540. | `gitlens.hovers.avatars` | Specifies whether to show avatar images in hovers |
  541. | `gitlens.hovers.currentLine.changes` | Specifies whether to provide a changes (diff) hover for the current line |
  542. | `gitlens.hovers.currentLine.details` | Specifies whether to provide a commit details hover for the current line |
  543. | `gitlens.hovers.currentLine.enabled` | Specifies whether to provide any hovers for the current line |
  544. | `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 |
  545. | `gitlens.hovers.enabled` | Specifies whether to provide any hovers |
  546. ### Modes Settings
  547. | Name | Description |
  548. | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
  549. | `gitlens.mode.active` | Specifies the active GitLens mode, if any |
  550. | `gitlens.mode.statusBar.enabled` | Specifies whether to provide the active GitLens mode in the status bar |
  551. | `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 |
  552. | `gitlens.modes` | Specifies the user-defined GitLens modes |
  553. ### Recent Changes Settings
  554. | Name | Description |
  555. | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  556. | `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) |
  557. | `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 |
  558. ### Status Bar Settings
  559. | Name | Description |
  560. | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  561. | `gitlens.statusBar.alignment` | Specifies the blame alignment in the status bar<br />`left` - aligns to the left<br />`right` - aligns to the right |
  562. | `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 |
  563. | `gitlens.statusBar.dateFormat` | Specifies the date format of absolute dates shown in the blame information in the status bar<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats |
  564. | `gitlens.statusBar.enabled` | Specifies whether to provide blame information in the status bar |
  565. | `gitlens.statusBar.format` | Specifies the format of the blame information in 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 |
  566. | `gitlens.statusBar.reduceFlicker` | Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing" |
  567. ### Advanced Settings
  568. | Name | Description |
  569. | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
  570. | `gitlens.advanced.blame.customArguments` | Specifies additional arguments to pass to the `git blame` command |
  571. | `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 |
  572. | `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 |
  573. | `gitlens.advanced.caching.enabled` | Specifies whether git output will be cached &mdash; changing the default is not recommended |
  574. | `gitlens.advanced.fileHistoryFollowsRenames` | Specifies whether file histories will follow renames -- will affect how merge commits are shown in histories |
  575. | `gitlens.advanced.maxListItems` | Specifies the maximum number of items to show in a list. Use 0 to specify no maximum |
  576. | `gitlens.advanced.messages` | Specifies which messages should be suppressed |
  577. | `gitlens.advanced.quickPick.closeOnFocusOut` | Specifies whether to close QuickPick menus when focus is lost |
  578. | `gitlens.advanced.repositorySearchDepth` | Specifies how many folders deep to search for repositories |
  579. | `gitlens.advanced.telemetry.enabled` | Specifies whether to enable GitLens telemetry (even if enabled still abides by the overall `telemetry.enableTelemetry` setting |
  580. #### Custom Remotes Settings
  581. | Name | Description |
  582. | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  583. | `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;`}]` |
  584. #### Strings Settings
  585. | Name | Description |
  586. | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
  587. | `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 |
  588. | `gitlens.strings.codeLens.unsavedChanges.recentChangeOnly` | Specifies the string to be shown in place of the `recent change` code lens when there are unsaved changes |
  589. | `gitlens.strings.codeLens.unsavedChanges.authorsOnly` | Specifies the string to be shown in place of the `authors` code lens when there are unsaved changes |
  590. ---
  591. ## Themable Colors
  592. 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).
  593. | Name | Description |
  594. | ------------------------------------------ | ----------------------------------------------------------------------------------------- |
  595. | `gitlens.gutterBackgroundColor` | Specifies the background color of the gutter blame annotations |
  596. | `gitlens.gutterForegroundColor` | Specifies the foreground color of the gutter blame annotations |
  597. | `gitlens.gutterUncommittedForegroundColor` | Specifies the foreground color of an uncommitted line in the gutter blame annotations |
  598. | `gitlens.trailingLineBackgroundColor` | Specifies the background color of the trailing blame annotation |
  599. | `gitlens.trailingLineForegroundColor` | Specifies the foreground color of the trailing blame annotation |
  600. | `gitlens.lineHighlightBackgroundColor` | Specifies the background color of the associated line highlights in blame annotations |
  601. | `gitlens.lineHighlightOverviewRulerColor` | Specifies the overview ruler color of the associated line highlights in blame annotations |
  602. ---
  603. ## Insiders
  604. 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.
  605. ---
  606. ## Contributors &#x1F64F;&#x2764;
  607. A big thanks to the people that have contributed to this project:
  608. - Amanda Cameron ([@AmandaCameron](https://github.com/AmandaCameron)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=AmandaCameron)
  609. - Brett Cannon ([@brettcannon](https://github.com/brettcannon)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=brettcannon)
  610. - Segev Finer ([@segevfiner](https://github.com/segevfiner)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=segevfiner)
  611. - Cory Forsyth ([@bantic](https://github.com/bantic)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=bantic)
  612. - Geoffrey ([@g3offrey](https://github.com/g3offrey)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=g3offrey)
  613. - Yukai Huang ([@Yukaii](https://github.com/Yukaii)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=Yukaii)
  614. - Roy Ivy III ([@rivy](https://github.com/rivy)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=rivy)
  615. - Helmut Januschka ([@hjanuschka](https://github.com/hjanuschka)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=hjanuschka)
  616. - Chris Kaczor ([@ckaczor](https://github.com/ckaczor)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=ckaczor)
  617. - korigod ([@korigod](https://github.com/korigod)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=korigod)
  618. - Peng Lyu ([@rebornix](https://github.com/rebornix)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=rebornix)
  619. - Cédric Malard ([@cmalard](https://github.com/cmalard)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=cmalard)
  620. - Aurelio Ogliari ([@nobitagit](https://github.com/nobitagit)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=nobitagit)
  621. - Maxim Pekurin ([@pmaxim25](https://github.com/pmaxim25)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=pmaxim25)
  622. - Johannes Rieken ([@jrieken](https://github.com/jrieken)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=jrieken)
  623. - ryenus ([@ryenus](https://github.com/ryenus)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=ryenus)
  624. - Zack Schuster ([@zackschuster](https://github.com/zackschuster)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=zackschuster)
  625. - SpaceEEC ([@SpaceEEC](https://github.com/SpaceEEC)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=SpaceEEC)
  626. - Alexey Vasyukov ([@notmedia](https://github.com/notmedia)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=notmedia)
  627. - Zyck ([@qzyse2017](https://github.com/qzyse2017)) &mdash; [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=qzyse2017)
  628. Also special thanks to the people that have provided support, testing, brainstorming, etc:
  629. - Brian Canzanella ([@bcanzanella](https://github.com/bcanzanella))
  630. - Matt King ([@KattMingMing](https://github.com/KattMingMing))
  631. And of course the awesome [vscode](https://github.com/Microsoft/vscode/graphs/contributors) team!