## Settings

collapse all expand all
Save Settings to

For advanced customizations, refer to the GitLens docs and edit your User Settings

Current Line Blame

Adds an unobtrusive blame annotation at the end of the current line

Use the GitLens: Toggle Line Blame Annotations command to override this setting for the current window

Show the Pull Request (if any) that introduced the commit

Requires a connection to a supported remote service (e.g. GitHub)

Annotation format
Example:
Include the annotation when scrolling the editor horizontally

When enabled the annotation can be scrolled into view when it is outside the viewport.

Setting this to `false` will inhibit the hovers from showing over the annotation; Set `gitlens.hovers.currentLine.over` to `line` to enable the hovers to show anywhere over the line.

For more options, open Settings and search for gitlens.currentLine

Git Code Lens

Adds authorship code lens to the top of files and on code blocks

Use the GitLens: Toggle Git Code Lens command to override this setting for the current window

Add the author and date of the most recent change for the file or code block
When clicked
Add the number of authors and the most prominent author of the file or code block
When clicked
Add code lens to the following scopes
File scope

At the top of the file

Containers scope

At the start of modules, classes, interfaces, etc

Block scope

At the start of functions, methods, etc

For more options, open Settings and search for gitlens.codeLens

Status Bar Blame

Adds a Git blame annotation about the current line to the status bar

Show the Pull Request (if any) that introduced the commit

Requires a connection to a supported remote service (e.g. GitHub)

Annotation format
Example:
Position the annotation on the
When clicked
Reduce flashing when updating the annotation

Avoids clearing the previous blame information when changing lines to reduce status bar "flashing"

For more options, open Settings and search for gitlens.statusBar

Hovers

Adds detailed blame information accessible via hovers

Use author avatars
Show the Pull Request (if any) that introduced the commit

Requires a connection to a supported remote service (e.g. GitHub)

Show hovers for the current line
Show hovers for the current line
Shown when over the
Shown when over the
Add blame details
Add changes (diff)
Show hovers while annotating
Shown when over the
Add blame details
Add changes (diff)

For more options, open Settings and search for gitlens.hovers

## Views

Adds rich views to visualize, navigate, and explore

GitLens views can be configured to be shown in different side bar layouts to best match your workflow

Source Control Layout (default)

Shows all the views together on the Source Control side bar

GitLens Layout

Shows all the views together on the GitLens side bar

You can also simply drag & drop individual views to create custom layouts

## Commits view

Adds a Commits view to visualize, explore, and manage Git commits

Show a comparison of the
with a user-selected reference (branch, tag, etc)
Show associated pull requests

Requires a connection to a supported remote service (e.g. GitHub)

Show the pull request associated with the current branch
Show the pull request that introduced each commit
Layout files

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Use author avatars
Commit label format
Example:
Commit description format
Example:

For more options, open Settings and search for gitlens.views.commits or gitlens.views

## Repositories view

Adds a Repositories view, hidden by default, to visualize, explore, and manage Git repositories

Show the following sections under each repository
Comparison of the
with a user-selected reference (branch, tag, etc)
Current branch status
Working tree file changes
Associated pull requests

Requires a connection to a supported remote service (e.g. GitHub)

Show the pull request associated with each branch
Show the pull request that introduced each commit
Commits
Branches
Remotes
Stashes
Tags
Contributors
Incoming Activity (experimental)
Automatically refresh when a repository or the file system changes
Automatically reveal repository when opening files
Use author avatars
Layout branches
Layout files

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Sort branches
Sort contributors
Sort tags

For more options, open Settings and search for gitlens.views.repositories or gitlens.views

## File History view

Adds a File History view to visualize, navigate, and explore the revision history of the current file, a specified file or folder, or just the selected lines of the current file

Layout files (when showing folder history)

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Use author avatars

For more options, open Settings and search for gitlens.views.fileHistory or gitlens.views

## Line History view

Adds a Line History view, hidden by default, to visualize, navigate, and explore the revision history of the selected lines of current file

Use author avatars

For more options, open Settings and search for gitlens.views.lineHistory or gitlens.views

## Branches view

Adds a Branches view to visualize, explore, and manage Git branches

Show a comparison of the branch with a user-selected reference (branch, tag, etc)
Show associated pull requests

Requires a connection to a supported remote service (e.g. GitHub)

Show the pull request associated with each branch
Show the pull request that introduced each commit
Layout branches
Sort branches
Layout files

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Use author avatars

For more options, open Settings and search for gitlens.views.branches or gitlens.views

## Remotes view

Adds a Remotes view to visualize, explore, and manage Git remotes and remote branches

Show associated pull requests

Requires a connection to a supported remote service (e.g. GitHub)

Show the pull request associated with each branch
Show the pull request that introduced each commit
Layout branches
Sort branches
Layout files

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Use author avatars

For more options, open Settings and search for gitlens.views.remotes or gitlens.views

## Stashes view

Adds a Stashes view to visualize, explore, and manage Git stashes

Layout files

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Stash label format
Example:
Stash description format
Example:

For more options, open Settings and search for gitlens.views.stashes or gitlens.views

## Tags view

Adds a Tags view to visualize, explore, and manage Git tags

Layout tags
Sort tags
Layout files

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Use author avatars

For more options, open Settings and search for gitlens.views.tags or gitlens.views

## Contributors view

Adds a Contributors view, hidden by default, to visualize, navigate, and explore contributors

Show commits from all branches
Show associated pull requests

Requires a connection to a supported remote service (e.g. GitHub)

Show the pull request that introduced each commit
Sort contributors
Layout files

Chooses the best layout based on the number of files at each nesting level

Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Use author avatars

For more options, open Settings and search for gitlens.views.contributors or gitlens.views

## Search & Compare view

Adds a Search & Compare view to search and explore commit histories by message, author, files, id, etc, or visualize comparisons between branches, tags, commits, and more

Show associated pull requests

Requires a connection to a supported remote service (e.g. GitHub)

Show the pull request that introduced each commit
Layout files
Use compact file layout

Compacts (flattens) unnecessary nesting when using a tree layouts

Use author avatars

For more options, open Settings and search for gitlens.views.searchAndCompare or gitlens.views

## Gutter Blame

Adds on-demand gutter blame annotations for the whole file

Use the GitLens: Toggle File Blame Annotations GitLens: Toggle File Blame Annotations command to turn the annotations on or off

Press `Esc` to turn off the annotations

Toggle annotations
Annotation format
Example:
Add a heatmap (age) indicator to show how recently lines were changed

Indicator color reflects the age of the most recent change (hot or cold), while indicator brightness ranges from bright (newer) to dim (older) based on the relative age

Position the heatmap on the
Add author avatars
Use compact view

Compacts (deduplicates) matching adjacent blame annotations

Highlight other lines changed by the same commit as the current line
Add gutter indicator
Add line highlight
Add scroll bar indicator

For more options, open Settings and search for gitlens.blame

## Gutter Changes

Adds on-demand gutter changes annotations to highlight any local (unpublished) changes or lines changed by the most recent commit

Use the GitLens: Toggle File Changes Annotations GitLens: Toggle File Changes Annotations command to turn the annotations on or off

Press `Esc` to turn off the annotations

Toggle annotations
Add gutter indicator
Add scroll bar indicator

For more options, open Settings and search for gitlens.changes

## Gutter Heatmap

Adds on-demand heatmap (age) indicator to the edge of the gutter to show how recently lines were changed

Use the GitLens: Toggle File Heatmap Annotations GitLens: Toggle File Heatmap Annotations command to turn the annotations on or off

Press `Esc` to turn off the annotations

Indicator color reflects the age of the most recent change (hot or cold), while indicator brightness ranges from bright (newer) to dim (older) based on the relative age

Toggle annotations
Add gutter indicator
Add scroll bar indicator
Hot/cold threshold days

For more options, open Settings and search for gitlens.heatmap

Interactive Rebase Editor

Adds a user-friendly interactive rebase editor to easily configure an interactive rebase session

## Dates & Times

Allow relative date formatting
Shows some dates relatively, e.g. 1 day ago Shows dates absolutely, e.g.
Date format
Example date:
Short date format
Example short date:
Time format
Example date:

For more options, open Settings and search for gitlens.default

Menus & Toolbars

Adds many helpful commands to the built-in menus & toolbars

Add to the editor context menu
Add Commit Changes submenu
Add Open * on Remote commands
Add Open File History and Quick Open File History commands
Add File Annotations submenu
Add to the Copy As submenu
Add to the editor tab context menu
Add Copy Remote File Url command
Add Commit Changes submenu
Add Open File on Remote * commands
Add Open File History and Quick Open File History commands
Add to the editor group toolbar
Add revision history navigation commands
Add
Add to the Explorer items context menu
Add Commit Changes submenu
Add Open File on Remote * commands
Add Open File History and Quick Open File History commands
Add Copy Remote File Url command
Add to the Source Control context menu
Add Add Co-authors command
Add to the Source Control groups toolbar
Add Stash All Changes command
Add to the Source Control groups context menu
Add Stash All Changes command
Add Open Changes submenu
Add Open Changed Files and Close Unchanged Files commands
Add to the Source Control items context menu
Add Open Changes submenu
Add Open File on Remote * commands
Add Open File History and Quick Open File History commands
Add Stash Changes command
Add Copy Remote File Url command

For more options, open Settings and search for gitlens.menus

## Keyboard Shortcuts

Use
keyboard shortcuts
`Alt` based (`⌥` on macOS) shortcuts. Not great for non-English keyboard layouts Chorded shortcuts that start with `Ctrl+Shift+G` (`⌥⌘G` on macOS). Better for non-English keyboard layouts GitLens won't bind any keyboard shortcuts. Configure your own via the Keyboard Shortcuts editor

Search for gitlens in the Keyboard Shortcuts editor to see the shortcuts and to customize them further

## Modes

Supports user-defined modes for quickly toggling between sets of settings

Use the GitLens: Switch Mode command to quickly switch the active mode

Use the GitLens: Toggle Review Mode command to toggle Review mode

Use the GitLens: Toggle Zen Mode command to toggle Zen mode

Show the active mode in the status bar
Position the annotation on the

For more options or to add your own custom modes, open Settings and search for gitlens.modes

#{endOfBody}