|
|
- [](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
- [](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
- [](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
- [](https://join.slack.com/t/vscode-dev-community/shared_invite/enQtMjIxOTgxNDE3NzM0LWU5M2ZiZDU1YjBlMzdlZjA2YjBjYzRhYTM5NTgzMTAxMjdiNWU0ZmQzYWI3MWU5N2Q1YjBiYmQ4MzY0NDE1MzY)
-
- <p align="center">
- <br />
- <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>
- </p>
-
- > 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.
-
- <br />
-
- # What's new in GitLens 8
- ## 8.3 — May 2018
- - Adds the ability to control where the *GitLens*, *GitLens History*, and *GitLens Results* explorers are shown 🎉 — closes [#213](https://github.com/eamodio/vscode-gitlens/issues/213), [#377](https://github.com/eamodio/vscode-gitlens/issues/377)
- - Adds `gitlens.gitExplorer.location` setting to the interactive settings editor to specify where the *GitLens* explorer is shown — either in the *Explorer* or *Source Control* view
- - Adds `gitlens.historyExplorer.location` setting to the interactive settings editor to specify where the *GitLens History* explorer is shown — either in the *Explorer* or *Source Control* view
- - Adds `gitlens.resultsExplorer.location` setting to the interactive settings editor to specify where the *GitLens Results* explorer is shown — either in the *Explorer* or *Source Control* view
- - Adds user-defined modes for quickly toggling between sets of settings
-
- 
-
- - Adds *Switch Mode* command (`gitlens.switchMode`) to quickly switch the active GitLens mode
- - Adds a built-in *Zen* mode which for a zen-like experience, disables many visual features
- - Adds *Toggle Zen Mode* command (`gitlens.toggleZenMode`) to toggle Zen mode
- - Adds a built-in *Review* mode which for reviewing code, enables many visual features
- - Adds *Toggle Review Mode* command (`gitlens.toggleReviewMode`) to toggle Review mode
- - Adds the active mode to the status bar, optional (on by default)
- - Adds `gitlens.mode.statusBar.enabled` setting to specify whether to provide the active GitLens mode on the status bar
- - Adds `gitlens.mode.statusBar.alignment` setting to specify the active GitLens mode alignment in the status bar
- - Adds modes settings (`gitlens.mode.*`) to the interactive settings editor
-
- 
-
- - Adds `gitlens.mode.active` setting to specify the active GitLens mode, if any
- - Adds `gitlens.modes` setting to specify the user-defined GitLens modes
- - Adds an icon for the *Compare File with Previous Revision* command (`gitlens.diffWithPrevious`) and moves it into the editor toolbar
- - Adds an icon for the *Compare File with Next Revision* command (`gitlens.diffWithNext`) and moves it into the editor toolbar
- - Adds menu settings (`gitlens.menus.*`) to the interactive settings editor
-
- 
-
- - Adds a display mode dropdown at the top of the interactive settings editor to reduce complexity
-
- 
-
- - Adds `gitlens.settings.mode` setting to specify the display mode of the interactive settings editor
- - Adds (re-adds) support for handling single files — closes [#321](https://github.com/eamodio/vscode-gitlens/issues/321)
- - Adds a tree layout option to tags in the *GitLens* explorer — closes [#358](https://github.com/eamodio/vscode-gitlens/issues/358)
- - Adds *Show GitLens Explorer* (`gitlens.showGitExplorer`) command — shows/expands the *GitLens* explorer
- - Adds *Show History Explorer* (`gitlens.showHistoryExplorer`) command — shows/expands the *GitLens History* explorer
- - Adds *Show Results Explorer* (`gitlens.showResultsExplorer`) command — shows/expands the *GitLens Results* explorer
- - Adds *Close Repository* (`gitlens.explorers.closeRepository`) command to repository and repository status nodes in the *GitLens* explorer — closes (hides) the repository in the *GitLens* explorer
- - Showing results in the *GitLens Results* explorer now properly shows the explorer first
- - Renames *Compare Line Revision with Previous* command (`gitlens.diffLineWithPrevious`) to *Compare Commit with Previous* for consistency with other commands
- - Renames *Compare Line Revision with Working File* command (`gitlens.diffLineWithWorking`) to *Compare Commit with Working File* for consistency with other commands
- - Renames *Show Commit File Details* command (`gitlens.showQuickCommitFileDetails`) to *Show Commit Details* for consistency with other commands
- - Reworks GitLens menu contributions and configuration — see menu settings above
- - Renames the `gitlens.advanced.menus` setting to `gitlens.menus`
- - Uses the new Webview API for better interactions and behavior with the interactive settings editor and welcome page
- - Fixes [#366](https://github.com/eamodio/vscode-gitlens/issues/366) - Running a GitLens command from a keybinding fails
- - Fixes [#155](https://github.com/eamodio/vscode-gitlens/issues/155) - Navigating file diffs with `alt+,` gets stuck
- - Fixes [#359](https://github.com/eamodio/vscode-gitlens/issues/359) - Show changes of an added file in the first commit
- - Fixes [#372](https://github.com/eamodio/vscode-gitlens/issues/372) - Wrong URL to VSTS work item when using hash work item id in commit
- - Fixes [#362](https://github.com/eamodio/vscode-gitlens/issues/362) - Too many code lenses in postcss files
- - Fixes [#381](https://github.com/eamodio/vscode-gitlens/issues/381) - Can't stash single files with older versions of Git
- - Fixes [#384](https://github.com/eamodio/vscode-gitlens/issues/384) - Absolute dates not always honored in *GitLens Results* explorer
- - Fixes [#385](https://github.com/eamodio/vscode-gitlens/issues/385) - Wrong git command to delete remote branch
- - Fixes *bronze* typo thanks to [PR #361](https://github.com/eamodio/vscode-gitlens/pull/361) by Cory Forsyth ([@bantic](https://github.com/bantic))
- - Fixes *individually* typo thanks to [PR #364](https://github.com/eamodio/vscode-gitlens/pull/364) by Brett Cannon ([@brettcannon](https://github.com/brettcannon))
- - Fixes issue where comparing previous revision during a merge/rebase conflict failed to show the correct contents
- - Fixes issue with the current line blame toggle not working when current line blame starts disabled
- - Fixes various issues when not on a branch
- - Fixes many issues where commands wouldn't work if the active file wasn't part of an open repository — now GitLens will try to find the best repository otherwise it will open a repository quick pick menu if there is more than one
-
- See the [release notes](https://github.com/eamodio/vscode-gitlens/blob/master/CHANGELOG.md "Open Release Notes") for the full set of changes
-
- # GitLens
-
- [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").
- While GitLens is generously offered to everyone free of charge, if you find it useful please consider [supporting](#support-gitlens "Support GitLens") it.
-
- 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.
-
- Here are just some of the features that GitLens provides,
- - a [*GitLens* explorer](#gitlens-explorer "Jump to the GitLens explorer") to navigate and explore repositories
- - a [*GitLens History* explorer](#gitlens-history-explorer "Jump to the GitLens History explorer") to navigate and explore file histories
- - 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
- - 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
- - an unobtrusive [current line blame](#current-line-blame "Jump to the Current Line Blame") annotation at the end of the line
- - on-demand [gutter blame](#gutter-blame "Jump to the Gutter Blame") annotations, including a heatmap, for the whole file
- - detailed blame information accessible via [hovers](#hovers "Jump to the Hovers")
- - on-demand [recent changes](#recent-changes "Jump to the Recent Changes") annotations to highlight lines changed by the most recent commit
- - a [status bar blame](#status-bar-blame "Jump to the Status Bar Blame") annotation showing author and date for the current line
- - [commit search](#commit-search "Jump to the Commit Search") — by message, author, filename, commit id, or code changes
- - many powerful commands for exploring commits and histories, comparing and navigating revisions, stash access, repository status, etc
- - and so much [more](#features "Jump to Features")
-
- GitLens is powerful, feature rich, and also [highly customizable](#gitlens-settings "Jump to the GitLens settings docs") to meet your specific needs — find code lens intrusive or the current line blame annotation distracting — 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").
-
- <p align="center">
- <br />
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/gitlens-preview.gif" alt="GitLens Preview" />
- <br />
- </p>
-
- ## Support GitLens
-
- While GitLens is generously offered to everyone free of charge, if you find it useful please consider supporting it.
-
- 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.
- From its very humble beginnings, GitLens has grown wildly beyond my expectations — in both its reach as well as its demands on my time and attention.
- While I enjoy giving my free time and attention to GitLens' development and growth, I would like to do even more.
-
- ### Show Your Support ❤
-
- To my incredible backers — 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.
-
- If you'd like to join them in supporting GitLens, please consider the following — feel free to choose more than one. 😉
- - [Become a Sponsor](https://www.patreon.com/eamodio "Become a sponsor on Patreon") — join the growing group of generous [backers](https://github.com/eamodio/vscode-gitlens/blob/master/BACKERS.md)
- - [Donations via PayPal](https://www.paypal.me/eamodio "One-time donations via PayPal")
- - [Donations via Cash App](https://cash.me/$eamodio "One-time donations via Cash App")
- - [Write a Review](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens#review-details "Write a review")
- - [Star or Fork me on GitHub](https://github.com/eamodio/vscode-gitlens "Star or fork me on GitHub")
- - [Follow me on Twitter](https://twitter.com/eamodio "Follow me on Twitter")
-
- #### Gold Sponsors ($300+)
- None yet — could be you!
-
- #### Silver Sponsors ($150+)
- None yet — could be you!
-
- #### Bronze Sponsors ($50+)
-
- - Michael Duffy
-
- ## Configuration
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/cl-settings.png" alt="GitLens Explorer Repository view" />
- </p>
-
- 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).
-
- For more advanced customizations, refer to the [settings documentation](#gitlens-settings "Jump to the GitLens settings docs") below.
-
- ## Features
-
- ### GitLens Explorer
- 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) — a Repository view and a History view.
- - A toolbar provides *Search Commits*, *Switch to Repository View* or *Switch to History View*, and *Refresh* commands
- - Quickly switch between views using the *Switch to Repository View* or *Switch to History View* commands
- - 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
-
- #### Repository view
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-explorer-repository.png" alt="GitLens Explorer Repository view" />
- </p>
-
- The repository view provides a full Git repository explorer, which has the following features,
-
- - **Repository Status**
- - 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)
- - Provides indicator dots on the repository icon which denote the following:
- - *None* — up-to-date with the upstream
- - *Green* — ahead of the upstream
- - *Red* — behind the upstream
- - *Yellow* — both ahead of and behind the upstream
- - Provides additional upstream status nodes, if the current branch is tracking a remote branch and,
- - is behind the upstream — quickly see and explore the specific commits behind the upstream (i.e. commits that haven't been pulled)
- - is ahead of the upstream — quickly see and explore the specific commits ahead of the upstream (i.e. commits that haven't been pushed)
- - A context menu provides *Open Repository in Remote*, and *Refresh* commands
- - **Changed Files** — lists all the "working" changes
- - 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
-
- - **Branches** — lists the local branches
- - Indicates which branch is the current branch and [optionally](#gitlens-explorer-settings "Jump to the GitLens explorer settings") shows the remote tracking branch
- - A context menu provides *Open Branches in Remote*, and *Refresh* commands
- - Branches expand to show its revision (commit) history
- - Provides indicator dots on each branch icon which denote the following:
- - *None* — no upstream or up-to-date with the upstream
- - *Green* — ahead of the upstream
- - *Red* — behind the upstream
- - *Yellow* — both ahead of and behind the upstream
- - Context menus for each branch provide
- - *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
- - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
- - Context menus for each revision (commit) provide
- - *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), *Rebase to Commit (via Terminal)* (when available), *Reset to Commit (via Terminal)* (when available), *Create Branch (via Terminal)...*, *Create Tag (via Terminal)...*, and *Refresh* commands
- - Context menus for each changed file provide
- - *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*, *Apply Changes*, and *Show Commit File Details* commands
- - Inline toolbars for each changed file provide an *Open File* command
-
- - **Remotes** — lists the remotes
- - Indicates the direction of the remote (fetch, push, both), remote service (if applicable), and repository path
- - A context menu provides a *Refresh* command
- - Remotes expands show its list of branches
- - Context menus for each remote provide
- - *Open Branches in Remote*, *Open Repository in Remote*, *Remove Remote (via Terminal)*, and *Refresh* commands
- - Branches expand to show its revision (commit) history
- - See the *Branches expand* section under **Branches** above for more details
-
- - **Stashes** — lists the stashed changes
- - A context menu provides *Stash Changes*, and *Refresh* commands
- - Stashes expand to show the set of files stashed, complete with status indicators for adds, changes, renames, and deletes
- - Context menus for each stash provide
- - *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
- - Context menus for each stashed file provide
- - *Apply Changes*, *Open Changes*, *Open Changes with Working File*, *Open File*, *Open Revision*, *Open File in Remote* (if available), and *Show File History* commands
-
- - **Tags** — lists the tags
- - A context menu provides a *Refresh* command
- - Tags expand to show its revision (commit) history
- - Context menus for each tag provide
- - *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
- - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
- - See the *Revisions (commits) expand* section under **Branches** above for more details
-
- ### History view
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-explorer-history.png" alt="GitLens Explorer History view" />
- </p>
-
- The history view provides the revision history of the current file, which has the following features,
- - Automatically updates to track the current editor
- - A context menu provides *Open File*, *Open File in Remote* (if available), and *Refresh* commands
- - An inline toolbar provides an *Open File* command
- - Context menus for each revision (commit) provides
- - *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*, and *Show Commit File Details* commands
-
- ---
- ### GitLens History Explorer
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-history-explorer.png" alt="GitLens History Explorer" />
- </p>
-
- A [customizable](#gitlens-history-explorer-settings "Jump to the GitLens History Explorer settings") stand-alone explorer to visualize the history of the current file — undocked version of the *GitLens* Explorer history view
- - Automatically updates to track the current editor
- - A context menu provides *Open File*, *Open File in Remote* (if available), and *Refresh* commands
- - An inline toolbar provides an *Open File* command
- - Context menus for each revision (commit) provides
- - *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*, and *Show Commit File Details* commands
-
- ---
- ### GitLens Results Explorer
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gitlens-results.png" alt="GitLens Results explorer" />
- </p>
-
- 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
- - A toolbar provides *Search Commits*, *Keep Results*, and *Refresh* commands
- - A context menu provides *Automatic Layout*, *List Layout*, *Tree Layout*, and *Close* commands
-
- #### Explore
- - Provides a semi-persistent results view for exploring histories, commits, and searches
- - Accessible via the following commands
- - *Show Commit Search* command (`gitlens.showCommitSearch`)
- - *Show File History* command (`gitlens.showQuickFileHistory`)
- - *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
- - An inline toolbar provides a *Clear Results* command
- - A context menu provides *Clear Results*, and *Refresh* commands
- - Revisions (commits) expand show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
- - Context menus for each revision (commit) provide
- - *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), *Rebase to Commit (via Terminal)* (when available), *Reset to Commit (via Terminal)* (when available), *Create Branch (via Terminal)...*, *Create Tag (via Terminal)...*, and *Refresh* commands
- - Context menus for each changed file provide
- - *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*, *Apply Changes*, and *Show Commit File Details* commands
-
- #### Compare
- - Provides a semi-persistent results view for comparison operations
- - Accessible via the following commands
- - *Compare with Remote* command (`gitlens.explorers.compareWithRemote`)
- - *Compare with HEAD* command (`gitlens.explorers.compareWithHead`)
- - *Compare with Working Tree* command (`gitlens.explorers.compareWithWorking`)
- - *Compare with Selected* command (`gitlens.explorers.compareWithSelected`)
- - *Compare Ancestry with Working Tree* command (`gitlens.explorers.compareAncestryWithWorking`)
- - An inline toolbar provides *Swap Comparision*, and *Clear Results* commands
- - A context menu provides *Clear Results*, *Swap Comparision*, *Open Directory Compare*, and *Refresh* commands
-
- - **Commits** — lists the commits between the compared revisions (branches or commits)
- - Revisions (commits) expand to show the set of files changed, complete with status indicators for adds, changes, renames, and deletes
- - See the *Revisions (commits) expand* section under **Explore** above for more details
-
- - **Changed Files** — lists the files changed between the compared revisions (branches or commits)
- - Expands to a file-based view of all changed files
- - Context menus for each changed file provide
- - *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*, *Apply Changes*, and *Show Commit File Details* commands
-
- ---
- ### Code Lens
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-code-lens.png" alt="Code Lens" />
- </p>
-
- - 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)
-
- - **Recent Change** — author and date of the most recent commit for the file or code block
- - 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"))
- - **Authors** — number of authors of the file or code block and the most prominent author (if there is more than one)
- - 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"))
- - 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
-
- - Provides [customizable](#code-lens-settings "Jump to the Code Lens settings") click behavior for each code lens — choose between one of the following
- - Toggle file blame annotations on and off
- - Compare the commit with the previous commit
- - Show a quick pick menu with details and commands for the commit
- - Show a quick pick menu with file details and commands for the commit
- - Show a quick pick menu with the commit history of the file
- - Show a quick pick menu with the commit history of the current branch
-
- - Adds a *Toggle Git Code Lens* command (`gitlens.toggleCodeLens`) with a shortcut of `shift+alt+b` to toggle the code lens on and off
-
- ---
- ### Current Line Blame
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-current-line-blame.png" alt="Current Line Blame" />
- </p>
-
- - 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
- - 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"))
- - Adds a *Toggle Line Blame Annotations* command (`gitlens.toggleLineBlame`) to toggle the blame annotation on and off
-
- ---
- ### Gutter Blame
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-gutter-blame.png" alt="Gutter Blame">
- </p>
-
- - 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
- - Contains the commit message and date, by [default](#gutter-blame-settings "Jump to the Gutter Blame settings")
- - 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 the age of a line ([optional](#gutter-blame-settings "Jump to the Gutter Blame settings"), on by default)
- - Indicator ranges from bright yellow (newer) to dark brown (older)
- - Adds a *Toggle File Blame Annotations* command (`gitlens.toggleFileBlame`) with a shortcut of `alt+b` to toggle the blame annotations on and off
- - Press `Escape` to turn off the annotations
-
- ---
- ### Gutter Heatmap
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-heatmap.png" alt="Gutter Heatmap" />
- </p>
-
- - Adds an on-demand **heatmap** to the edge of the gutter to show the relative age of a line
- - Indicator ranges from bright yellow (newer) to dark brown (older)
- - Adds *Toggle File Heatmap Annotations* command (`gitlens.toggleFileHeatmap`) to toggle the heatmap on and off
- - Press `Escape` to turn off the annotations
-
- ---
- ### Hovers
- #### Current Line Hovers
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-current-line.png" alt="Current Line Hovers" />
- </p>
-
- - Adds [customizable](#hover-settings "Jump to the Hover settings") Git blame hovers accessible over the current line
-
- ##### Details Hover
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-current-line-details.png" alt="Current Line Details Hover" />
- </p>
-
- - 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)
- - Provides automatic issue linking to Bitbucket, GitHub, GitLab, and Visual Studio Team Services in commit messages
- - Provides a **quick-access command bar** with *Open Changes*, *Blame Previous Revision*, *Open in Remote*, and *Show More Actions* command buttons
- - Click the commit id to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
-
- ##### Changes (diff) Hover
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-current-line-changes.png" alt="Current Line Changes (diff) Hover" />
- </p>
-
- - 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)
- - Click the **Changes** to execute the *Compare File Revisions* command (`gitlens.diffWith`)
- - Click the current and previous commit ids to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
-
- #### Annotation Hovers
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-annotations.png" alt="Annotation Hovers" />
- </p>
-
- - Adds [customizable](#hover-settings "Jump to the Hover settings") Git blame hovers accessible when annotating
-
- ##### Details Hover
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-annotations-details.png" alt="Annotations Details Hover" />
- </p>
-
- - 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)
- - Provides automatic issue linking to Bitbucket, GitHub, GitLab, and Visual Studio Team Services in commit messages
- - Provides a **quick-access command bar** with *Open Changes*, *Blame Previous Revision*, *Open in Remote*, and *Show More Actions* command buttons
- - Click the commit id to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
-
- ##### Changes (diff) Hover
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-hovers-annotations-changes.png" alt="Annotations Changes (diff) Hover" />
- </p>
-
- - 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)
- - Click the **Changes** to execute the *Compare File Revisions* command (`gitlens.diffWith`)
- - Click the current and previous commit ids to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
-
- ---
- ### Modes
- - GitLens supports [user-defined](#modes-settings "Jump to the Modes settings") modes for quickly toggling between sets of settings
- - Adds *Switch Mode* command (`gitlens.switchMode`) to quickly switch the active mode
- - Adds a built-in *Zen* mode which for a zen-like experience, disables many visual features
- - Adds *Toggle Zen Mode* command (`gitlens.toggleZenMode`) to toggle Zen mode
- - Adds a built-in *Review* mode which for reviewing code, enables many visual features
- - Adds *Toggle Review Mode* command (`gitlens.toggleReviewMode`) to toggle Review mode
- - Adds the active mode to the **status bar** ([optional](#modes-settings "Jump to the Modes settings"), on by default)
-
- ---
- ### Recent Changes
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-recent-changes.png" alt="Recent Changes" />
- </p>
-
- - 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
- - Adds *Toggle Recent File Changes Annotations* command (`gitlens.toggleFileRecentChanges`) to toggle the recent changes annotations on and off
- - Press `Escape` to turn off the annotations
-
- ---
- ### Status Bar Blame
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-status-bar.png" alt="Status Bar Blame" />
- </p>
-
- - 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)
-
- - Contains the commit author and date (by [default](#status-bar-settings "Jump to the Status Bar Blame settings"))
- - 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"))
-
- - Provides [customizable](#status-bar-settings "Jump to the Status Bar Blame settings") click behavior — choose between one of the following
- - Toggle file blame annotations on and off
- - Toggle code lens on and off
- - Compare the line commit with the previous commit
- - Compare the line commit with the working tree
- - Show a quick pick menu with details and commands for the commit (default)
- - Show a quick pick menu with file details and commands for the commit
- - Show a quick pick menu with the commit history of the file
- - Show a quick pick menu with the commit history of the current branch
-
- ---
- ### Commit Search
- - 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
- - Use `<message>` to search for commits with messages that match `<message>` — See [Git docs](https://git-scm.com/docs/git-log#git-log---grepltpatterngt "Open Git docs")
- - Use `@<pattern>` to search for commits with authors that match `<pattern>` — See [Git docs](https://git-scm.com/docs/git-log#git-log---authorltpatterngt "Open Git docs")
- - Use `:<pattern>` to search for commits with file names that match `<pattern>` — See [Git docs](https://git-scm.com/docs/git-log "Open Git docs")
- - Use `#<sha>` to search for a commit with id of `<sha>` — See [Git docs](https://git-scm.com/docs/git-log "Open Git docs")
- - Use `~<pattern>` to search for commits with differences whose patch text contains added/removed lines that match `<pattern>` — See [Git docs](https://git-scm.com/docs/git-log#git-log--Gltregexgt "Open Git docs")
- - 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 — See [Git docs](https://git-scm.com/docs/git-log#git-log--Sltstringgt "Open Git docs")
- - Provides a *Show in Results* option to show the search results in the *GitLens Results* explorer
-
- ---
- ### Navigate and Explore
-
- - 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
-
- - 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") — only available if a Git upstream service is configured in the repository
- - 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**
- - *Open Branches in Remote* command (`gitlens.openBranchesInRemote`) — opens the branches in the supported remote service
- - *Open Branch in Remote* command (`gitlens.openBranchInRemote`) — opens the current branch commits in the supported remote service
- - *Open Commit in Remote* command (`gitlens.openCommitInRemote`) — opens the commit revision of the current line in the supported remote service
- - *Open File in Remote* command (`gitlens.openFileInRemote`) — opens the current file/revision in the supported remote service
- - *Open Repository in Remote* command (`gitlens.openRepoInRemote`) — opens the repository in the supported remote service
-
- #### Branch History
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-branch-history.png" alt="Branch History Quick Pick Menu" />
- </p>
-
- - 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
- - Provides entries to *Show Commit Search* and *Open Branch in \<remote-service\>* when available
- - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
- - Navigate pages via `alt+,` and `alt+.` to go backward and forward respectively
-
- - 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
- - Provides the same features as *Show Current Branch History* above
-
- #### File History
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-file-history.png" alt="File History Quick Pick Menu" />
- </p>
-
- - 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
- - Provides additional entries to *Show in Results*, *Show Branch History*, and *Open File in \<remote-service\>* when available
- - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
- - Navigate pages via `alt+,` and `alt+.` to go backward and forward respectively
-
- #### Commit Details
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-commit-details.png" alt="Commit Details Quick Pick Menu" />
- </p>
-
- - 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
- - Quickly see the set of files changed in the commit, complete with status indicators for adds, changes, renames, and deletes
- - 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*
- - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
- - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible — 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
- - 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
-
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-commit-file-details.png" alt="Commit File Details Quick Pick Menu" />
- </p>
-
- - 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
- - 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*
- - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
- - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible — 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
-
- #### Repository Status
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-repo-status.png" alt="Repository Status Quick Pick Menu" />
- </p>
-
- - 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
- - Quickly see upstream status (if an Git upstream is configured) — complete with ahead and behind information
- - 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
- - 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
- - Quickly see all working changes, both staged and unstaged, complete with status indicators for adds, changes, renames, and deletes
- - Provides entries to *Show Stashed Changes*, *Open Changed Files*, and *Close Unchanged Files*
- - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible — 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
- - 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
-
- #### Stashes
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-stash-list.png" alt="Stashed Changes Quick Pick Menu" />
- </p>
-
- - Adds a *Show Stashed Changes* command (`gitlens.showQuickStashList`) to show a **stashed changes quick pick menu** for exploring your repository stash history
- - Provides additional entries to *Stash Changes*
- - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
-
- - Adds a *Stash Changes* command (`gitlens.stashSave`) to save any working tree changes to the stash — can optionally provide a stash message
- - Also adds the command to the Source Control items context menu to stash an individual or group of files, works with multi-select too!
-
- #### Stash Details
- <p align="center">
- <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-menu-stash-details.png" alt="Stash Details Quick Pick Menu" />
- </p>
-
- - Stashed changes show a **stash details quick pick menu** which is very similar to the **commit details quick pick menu** above
- - Quickly see the set of files changed in the stash, complete with status indicators for adds, changes, renames, and deletes
- - 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*
- - Navigate back to the previous quick pick menu via `alt+left arrow`, if available
- - Use the `alt+right arrow` shortcut on an entry to execute it without closing the quick pick menu, if possible — 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
- - 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
-
- - Adds a *Apply Stashed Changes* command (`gitlens.stashApply`) to chose a stash entry to apply to the working tree from a quick pick menu
-
- ---
- ### Powerful Comparison Tools
-
- - Effortlessly navigate between comparisons via the `alt+,` and `alt+.` shortcut keys to go back and forth through a file's revisions
-
- - Provides easy access to the following comparison commands via the `Command Palette` as well as in context via the many provided quick pick menus
-
- - 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
-
- - Adds a *Compare HEAD with Branch or Tag...* command (`gitlens.diffHeadWithBranch`) to compare the index (HEAD) with the selected branch or tag
-
- - Adds a *Compare Working Tree with Branch or Tag...* command (`gitlens.diffWorkingWithBranch`) to compare the working tree with the selected branch or tag
-
- - 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
-
- - 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
-
- - 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
-
- - 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
-
- - Adds a *Compare File with Revision...* command (`gitlens.diffWithRevision`) to compare the current file with the selected revision of the same file
-
- - 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
-
- - 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
-
- ---
- ### And More
-
- - 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
-
- - 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
-
- - Adds a *Open Working File"* command (`gitlens.openWorkingFile`) to open the working file for the current file revision
-
- - Adds a *Open Revision...* command (`gitlens.openFileRevision`) to open the selected revision for the current file
-
- - 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
-
- - Adds a *Open All Changes (with difftool)* command (`gitlens.externalDiffAll`) to open all working changes with the configured git difftool
- - Also adds the command to the Source Control group context menu
-
- - Adds a *Open Changed Files* command (`gitlens.openChangedFiles`) to open any files with working tree changes
-
- - Adds a *Close Unchanged Files* command (`gitlens.closeUnchangedFiles`) to close any files without working tree changes
-
- ---
- ## GitLens Settings
-
- GitLens is highly customizable and provides many configuration settings to allow the personalization of almost all features.
-
- ### General Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.defaultDateFormat`|Specifies how absolute dates will be formatted by default<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats
- |`gitlens.defaultDateStyle`|Specifies how dates will be displayed by default
- |`gitlens.defaultGravatarsStyle`|Specifies the style of the gravatar default (fallback) images<br />`identicon` - a geometric pattern<br />`mm` - (mystery-man) 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` - faces with differing features and backgrounds
- |`gitlens.insiders`|Opts into the insiders channel — provides access to upcoming features
- |`gitlens.keymap`|Specifies the keymap to use for GitLens shortcut keys<br />`alternate` - adds an alternate set of shortcut keys that start with `Alt` (⌥ on macOS)<br />`chorded` - adds a chorded set of shortcut keys that start with `Ctrl+Shift+G` (<code>⌥⌘G</code> on macOS)<br />`none` - no shortcut keys will be added
- |`gitlens.menus`|Specifies which commands will be added to which menus
- |`gitlens.outputLevel`|Specifies how much (if any) output will be sent to the GitLens output channel
- |`gitlens.settings.mode`|Specifies the display mode of the interactive settings editor<br />`simple` - only displays common settings<br />`advanced` - displays all settings
- |`gitlens.showWhatsNewAfterUpgrades`|Specifies whether to show What's New after upgrading to new feature releases
-
- ### GitLens Explorer Settings
-
- See also [Explorer Settings](#explorer-settings "Jump to the Explorer settings")
-
- |Name | Description
- |-----|------------
- |`gitlens.gitExplorer.autoRefresh`|Specifies whether to automatically refresh the *GitLens* explorer when the repository or the file system changes
- |`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 `/`
- |`gitlens.gitExplorer.enabled`|Specifies whether to show the *GitLens* explorer"
- |`gitlens.gitExplorer.files.compact`|Specifies whether to compact (flatten) unnecessary file nesting in the *GitLens* explorer<br />Only applies when displaying files as a `tree` or `auto`
- |`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` setting and the number of files at each nesting level<br /> `list` - displays files as a list<br /> `tree` - displays files as a tree
- |`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 displaying files as `auto`
- |`gitlens.gitExplorer.includeWorkingTree`|Specifies whether to include working tree files inside the `Repository Status` node of the *GitLens* explorer
- |`gitlens.gitExplorer.location`|Specifies where to show the `GitLens` explorer<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view
- |`gitlens.gitExplorer.showTrackingBranch`|Specifies whether to show the tracking branch when displaying local branches in the *GitLens* explorer"
- |`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"
-
- ### GitLens History Explorer Settings
-
- See also [Explorer Settings](#explorer-settings "Jump to the Explorer settings")
-
- |Name | Description
- |-----|------------
- |`gitlens.historyExplorer.enabled`|Specifies whether to show the current file history undocked in a *GitLens History* explorer
- |`gitlens.historyExplorer.location`|Specifies where to show the `GitLens History` explorer<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view
-
- ### GitLens Results Explorer Settings
-
- See also [Explorer Settings](#explorer-settings "Jump to the Explorer settings")
-
- |Name | Description
- |-----|------------
- |`gitlens.resultsExplorer.files.compact`|Specifies whether to compact (flatten) unnecessary file nesting in the *GitLens Results* explorer<br />Only applies when displaying files as a `tree` or `auto`
- |`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` setting and the number of files at each nesting level<br /> `list` - displays files as a list<br /> `tree` - displays files as a tree
- |`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 displaying files as `auto`
- |`gitlens.resultsExplorer.location`|Specifies where to show the `GitLens Results` explorer<br />`explorer` - adds to the Explorer view<br />`scm` - adds to the Source Control view
-
- ### Explorer Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.explorers.avatars`|Specifies whether to show avatar images instead of commit (or status) icons in the *GitLens* and *GitLens Results* explorers
- |`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
- |`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
- |`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
- |`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
- |`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
-
- ### Code Lens Settings
-
- |Name | Description
- |-----|------------
- |`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
- |`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)
- |`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
- |`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
- |`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
- |`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
- |`gitlens.codeLens.scopesByLanguage`|Specifies where Git code lens will be shown in the document for the specified languages
- |`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)
-
- #### Current Line Blame Settings
-
- |Name | Description
- |-----|------------
- |`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
- |`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
- |`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
- |`gitlens.currentLine.scrollable`|Specifies whether the current line blame annotation can be scrolled into view when it is outside the viewport
-
- ### Gutter Blame Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.blame.avatars`|Specifies whether to show avatar images in the gutter blame annotations
- |`gitlens.blame.compact`|Specifies whether to compact (deduplicate) matching adjacent gutter blame annotations
- |`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
- |`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
- |`gitlens.blame.heatmap.enabled`|Specifies whether to provide a heatmap indicator in the gutter blame annotations
- |`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
- |`gitlens.blame.highlight.enabled`|Specifies whether to highlight lines associated with the current line
- |`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)
- |`gitlens.blame.ignoreWhitespace`|Specifies whether to ignore whitespace when comparing revisions during blame operations
- |`gitlens.blame.separateLines`|Specifies whether gutter blame annotations will have line separators
- |`gitlens.blame.toggleMode`|Specifies how the gutter blame annotations will be toggled<br />`file` - toggle each file individually<br />`window` - toggle the window, i.e. all files at once
-
- ### Gutter Heatmap Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.heatmap.toggleMode`|Specifies how the gutter heatmap annotations will be toggled<br />`file` - toggle each file individually<br />`window` - toggle the window, i.e. all files at once
-
- ### Hover Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.hovers.annotations.changes`|Specifies whether to provide a changes (diff) hover for all lines when showing blame annotations
- |`gitlens.hovers.annotations.details`|Specifies whether to provide a commit details hover for all lines when showing blame annotations
- |`gitlens.hovers.annotations.enabled`|Specifies whether to provide any hovers when showing blame annotations
- |`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
- |`gitlens.hovers.currentLine.changes`|Specifies whether to provide a changes (diff) hover for the current line
- |`gitlens.hovers.currentLine.details`|Specifies whether to provide a commit details hover for the current line
- |`gitlens.hovers.currentLine.enabled`|Specifies whether to provide any hovers for the current line
- |`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
- |`gitlens.hovers.enabled`|Specifies whether to provide any hovers
-
- ### Modes Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.mode.active`|Specifies the active GitLens mode, if any
- |`gitlens.mode.statusBar.enabled`|Specifies whether to provide the active GitLens mode on the status bar
- |`gitlens.mode.statusBar.alignment`|Specifies the active GitLens mode alignment in the status bar<br />`left` - align to the left<br />`right` - align to the right
- |`gitlens.modes`|Specifies the user-defined GitLens modes
-
- ### Recent Changes Settings
-
- |Name | Description
- |-----|------------
- |`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)
- |`gitlens.recentChanges.toggleMode`|Specifies how the recently changed lines annotations will be toggled<br />`file` - toggle each file individually<br />`window` - toggle the window, i.e. all files at once
-
- ### Status Bar Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.statusBar.alignment`|Specifies the blame alignment in the status bar<br />`left` - align to the left<br />`right` - align to the right
- |`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
- |`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
- |`gitlens.statusBar.enabled`|Specifies whether to provide blame information on the status bar
- |`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
- |`gitlens.statusBar.reduceFlicker`|Specifies whether to avoid clearing the previous blame information when changing lines to reduce status bar "flashing"
-
- ### Advanced Settings
-
- |Name | Description
- |-----|------------
- |`gitlens.advanced.blame.customArguments`|Specifies additional arguments to pass to the `git blame` command
- |`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
- |`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
- |`gitlens.advanced.caching.enabled`|Specifies whether git output will be cached — changing the default is not recommended
- |`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
- |`gitlens.advanced.fileHistoryFollowsRenames`|Specifies whether file histories will follow renames -- will affect how merge commits are shown in histories
- |`gitlens.advanced.maxListItems`|Specifies the maximum number of items to show in a list. Use 0 to specify no maximum
- |`gitlens.advanced.messages`|Specifies which messages should be suppressed
- |`gitlens.advanced.quickPick.closeOnFocusOut`|Specifies whether to close QuickPick menus when focus is lost
- |`gitlens.advanced.repositorySearchDepth`|Specifies how many folders deep to search for repositories
- |`gitlens.advanced.telemetry.enabled`|Specifies whether to enable GitLens telemetry (even if enabled still abides by the overall `telemetry.enableTelemetry` setting
-
- #### Custom Remotes Settings
-
- |Name | Description
- |-----|------------
- |`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 /> ```"domain": "git.corporate-url.com",```<br /> ```"type": "Custom",```<br /> ```"name": "My Company", ```<br /> ```"protocol": "https",```<br /> ```"urls": {```<br /> ```"repository": "https://git.corporate-url.com/${repo}",```<br /> ```"branches": "https://git.corporate-url.com/${repo}/branches",```<br /> ```"branch": "https://git.corporate-url.com/${repo}/commits/${branch}",```<br /> ```"commit": "https://git.corporate-url.com/${repo}/commit/${id}",```<br /> ```"file": "https://git.corporate-url.com/${repo}?path=${file}${line}",```<br /> ```"fileInBranch": "https://git.corporate-url.com/${repo}/blob/${branch}/${file}${line}",```<br /> ```"fileInCommit": "https://git.corporate-url.com/${repo}/blob/${id}/${file}${line}",```<br /> ```"fileLine": "#L${line}",```<br /> ```"fileRange": "#L${start}-L${end}"```<br /> ```}```<br /> ```}]```<br /><br />Example:<br />```"gitlens.remotes": [{ ```<br /> ```"domain": "git.corporate-url.com",```<br /> ```"type": "Custom",```<br /> ```"name": "My Company", ```<br /> ```"protocol": "https",```<br /> ```"urls": {```<br /> ```"repository": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}",```<br /> ```"branches": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/branches",```<br /> ```"branch": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/commits/${branch}",```<br /> ```"commit": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/commit/${id}",```<br /> ```"file": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}?path=${file}${line}",```<br /> ```"fileInBranch": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/blob/${branch}/${file}${line}",```<br /> ```"fileInCommit": "https://git.corporate-url.com/projects/${repoBase}/repos/${repoPath}/blob/${id}/${file}${line}",```<br /> ```"fileLine": "#L${line}",```<br /> ```"fileRange": "#L${start}-L${end}"```<br /> ```}```<br /> ```}]```
-
- #### Strings Settings
-
- |Name | Description
- |-----|------------
- |`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
- |`gitlens.strings.codeLens.unsavedChanges.recentChangeOnly`|Specifies the string to be shown in place of the `recent change` code lens when there are unsaved changes
- |`gitlens.strings.codeLens.unsavedChanges.authorsOnly`|Specifies the string to be shown in place of the `authors` code lens when there are unsaved changes
-
- ---
- ## Themable Colors
-
- 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).
-
- |Name | Description
- |-----|------------
- |`gitlens.gutterBackgroundColor`|Specifies the background color of the gutter blame annotations
- |`gitlens.gutterForegroundColor`|Specifies the foreground color of the gutter blame annotations
- |`gitlens.gutterUncommittedForegroundColor`|Specifies the foreground color of an uncommitted line in the gutter blame annotations
- |`gitlens.trailingLineBackgroundColor`|Specifies the background color of the trailing blame annotation
- |`gitlens.trailingLineForegroundColor`|Specifies the foreground color of the trailing blame annotation
- |`gitlens.lineHighlightBackgroundColor`|Specifies the background color of the associated line highlights in blame annotations
- |`gitlens.lineHighlightOverviewRulerColor`|Specifies the overview ruler color of the associated line highlights in blame annotations
-
- ---
- ## Insiders
-
- 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.
-
- ---
- ## Contributors 🙏❤
-
- A big thanks to the people that have contributed to this project:
-
- - Amanda Cameron ([@AmandaCameron](https://github.com/AmandaCameron)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=AmandaCameron)
- - Brett Cannon ([@brettcannon](https://github.com/brettcannon)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=brettcannon)
- - Cory Forsyth ([@bantic](https://github.com/bantic)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=bantic)
- - Geoffrey ([@g3offrey](https://github.com/g3offrey)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=g3offrey)
- - Yukai Huang ([@Yukaii](https://github.com/Yukaii)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=Yukaii)
- - Helmut Januschka ([@hjanuschka](https://github.com/hjanuschka)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=hjanuschka)
- - Chris Kaczor ([@ckaczor](https://github.com/ckaczor)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=ckaczor)
- - Peng Lyu ([@rebornix](https://github.com/rebornix)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=rebornix)
- - Cédric Malard ([@cmalard](https://github.com/cmalard)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=cmalard)
- - Aurelio Ogliari ([@nobitagit](https://github.com/nobitagit)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=nobitagit)
- - Johannes Rieken ([@jrieken](https://github.com/jrieken)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=jrieken)
- - ryenus ([@ryenus](https://github.com/ryenus)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=ryenus)
- - Zack Schuster ([@zackschuster](https://github.com/zackschuster)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=zackschuster)
- - SpaceEEC ([@SpaceEEC](https://github.com/SpaceEEC)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=SpaceEEC)
- - Alexey Vasyukov ([@notmedia](https://github.com/notmedia)) — [contributions](https://github.com/eamodio/vscode-gitlens/commits?author=notmedia)
-
- Also special thanks to the people that have provided support, testing, brainstorming, etc:
-
- - Brian Canzanella ([@bcanzanella](https://github.com/bcanzanella))
- - Matt King ([@KattMingMing](https://github.com/KattMingMing))
-
- And of course the awesome [vscode](https://github.com/Microsoft/vscode/graphs/contributors) team!
|
