GitLens Settings Overview

Available commands include:
gitlens.toggleFileBlame, gitlens.toggleFileHeatmap, gitlens.toggleFileChanges, gitlens.toggleFileChangesOnly, gitlens.diffWithPrevious, gitlens.revealCommitInView, gitlens.showCommitsInView, gitlens.showQuickCommitDetails, gitlens.showQuickCommitFileDetails, gitlens.showQuickFileHistory, gitlens.showQuickRepoHistory, gitlens.openCommitOnRemote, gitlens.copyRemoteCommitUrl, gitlens.openFileOnRemote, gitlens.copyRemoteFileUrl.

Available commands mirror those listed under authors.command.

left – aligns to the left
right – aligns to the right

gitlens.toggleFileBlame, gitlens.toggleFileHeatmap, gitlens.toggleFileChanges, gitlens.toggleFileChangesOnly, gitlens.diffWithPrevious, gitlens.revealCommitInView, gitlens.showCommitsInView, gitlens.showQuickCommitDetails, gitlens.showQuickCommitFileDetails, gitlens.showQuickFileHistory, gitlens.showQuickRepoHistory, gitlens.openCommitOnRemote, gitlens.copyRemoteCommitUrl, gitlens.openFileOnRemote, gitlens.copyRemoteFileUrl

annotation – hover only on the annotation
line – hover anywhere on the line

line – shows only changes to the line
hunk – shows related changes (code hunk)

annotation – hover only on the annotation
line – hover anywhere on the line

auto – switches between tree and list based on the threshold
list – displays a flat file list
tree – displays a hierarchical file structure

false – hides comparison section
branch – compares current branch to another reference
working – compares working tree to a selected reference

list – shows all branches in a list
tree – groups branches in a tree structure if names contain /

auto – switches based on file count and nesting
list – flat file list
tree – hierarchical file view

show – includes merge commits
hide – excludes merge commits

list – shows branches as a list
tree – groups branches into a tree structure

auto – switches between tree and list based on the threshold
list – displays a flat list
tree – displays files hierarchically

false – hides comparisons
branch – compares the current branch with a selected reference

list – shows branches in a flat list
tree – groups branches hierarchically

auto – switches between tree and list depending on nesting
list – flat file list
tree – hierarchical file view

false – hides comparisons
branch – compares the current branch with a selected reference

auto – switches between tree and list layouts based on nesting
list – shows a flat list
tree – shows a hierarchical view

list – displays tags as a flat list
tree – groups tags hierarchically

auto – switches between tree and list layouts based on nesting
list – shows a flat list
tree – shows a hierarchical view

auto – automatically switches between tree and list views based on the threshold
list – shows files in a flat list
tree – shows files hierarchically

false – hides comparisons
branch – compares with a selected reference (e.g., tag or branch)

auto – automatically switches between displaying files as a tree or list based on the gitlens.views.commits.files.threshold value and the number of files at each nesting level
list – displays files as a list
tree – displays files as a tree

auto – switches between tree and list based on nesting and threshold
list – shows files in a flat list
tree – shows files hierarchically

auto – switches between tree and list based on nesting and threshold
list – shows files in a flat list
tree – shows files hierarchically

left – left edge of annotations
right – right edge of annotations

file – file indicator
line – full-line background highlight
overview – decoration in the overview ruler

file – toggles blame per file
window – toggles blame for all files in the window

gutter – shows a file indicator in the gutter
overview – adds a decoration in the overview ruler (scroll bar)

file – toggles annotations per file
window – toggles annotations for all files in the window

gutter – shows indicator in the gutter
overview – adds a decoration in the overview ruler (scroll bar)

file – toggles annotations per file
window – toggles annotations for all files in the window

name – alphabetically by command name
usage – by last used date

Supported types include:

• GitHub
• GitLab
• Gerrit
• GoogleSource
• Gitea
• AzureDevOps
• Bitbucket
• BitbucketServer
• Custom

Examples:

"gitlens.remotes": [{ "domain": "git.corporate-url.com", "type": "GitHub" }]

"gitlens.remotes": [{ "regex": "ssh:\/\/(my\.company\.com):1234\/git\/(.+)", "type": "GitHub" }]

Custom example:

"gitlens.remotes": [{
  "domain": "git.corporate-url.com",
  "type": "Custom",
  "name": "My Company",
  "protocol": "https",
  "urls": {
    "repository": "https://git.corporate-url.com/${repo}",
    "branches": "https://git.corporate-url.com/${repo}/branches",
    "branch": "https://git.corporate-url.com/${repo}/commits/${branch}",
    "commit": "https://git.corporate-url.com/${repo}/commit/${id}",
    "file": "https://git.corporate-url.com/${repo}?path=${file}${line}",
    "fileInBranch": "https://git.corporate-url.com/${repo}/blob/${branch}/${file}${line}",
    "fileInCommit": "https://git.corporate-url.com/${repo}/blob/${id}/${file}${line}",
    "fileLine": "#L${line}",
    "fileRange": "#L${start}-L${end}"
  }
}]

Another custom example:

"gitlens.remotes": [{
  "regex": "ssh:\/\/(my\.company\.com):1234\/git\/(.+)",
  "type": "Custom",
  "name": "My Company",
  "protocol": "https",
  "urls": {
    "repository": "https://my.company.com/projects/${repoBase}/repos/${repoPath}",
    "branches": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/branches",
    "branch": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/commits/${branch}",
    "commit": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/commit/${id}",
    "file": "https://my.company.com/projects/${repoBase}/repos/${repoPath}?path=${file}${line}",
    "fileInBranch": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/blob/${branch}/${file}${line}",
    "fileInCommit": "https://my.company.com/projects/${repoBase}/repos/${repoPath}/blob/${id}/${file}${line}",
    "fileLine": "#L${line}",
    "fileRange": "#L${start}-L${end}"
  }
}]

null (default) – shows a menu to select which file annotations to toggle
blame – toggles file blame annotations
heatmap – toggles file heatmap annotations
changes – toggles file changes annotations

alternate – adds alternate shortcuts starting with Alt (⌥ on macOS)
chorded – adds chorded shortcuts starting with Ctrl+Shift+G (⌥⌘G on macOS)
none – disables all GitLens shortcut keys

left – aligns left
right – aligns right

Example: Add heatmap annotations to a Reviewing mode:
"gitlens.modes": { "review": { "annotations": "heatmap" } }

Example: Define a new Annotating mode with blame annotations:

"gitlens.modes": {
  "annotate": {
    "name": "Annotating",
    "statusBarItemName": "Annotating",
    "description": "for root cause analysis",
    "annotations": "blame",
    "codeLens": false,
    "currentLine": false,
    "hovers": true
  }
}

Example for Jira issues:
JIRA-123 ⟶ https://jira.company.com/issue?query=123
"gitlens.autolinks": [{ "prefix": "JIRA-", "url": "https://jira.company.com/issue?query=<num>" }]

identicon – geometric pattern
mp – cartoon-style silhouette (same for all emails)
monsterid – colorful monster faces
retro – 8-bit pixelated faces
robohash – robot faces with variations
wavatar – faces with different features and backgrounds

date – reverse chronological by commit timestamp
author-date – reverse chronological by author timestamp
topo – reverse chronological but avoids mixing multiple lines of history

${userHome} – user’s home directory
${workspaceFolder} – path of the opened folder in VS Code containing the repository
${workspaceFolderBasename} – name of the opened folder in VS Code without slashes

tab – in a tab in the editor area
view – in the side bar, draggable to side bar, secondary side bar, or panel locations

panel (default) – shows in a panel
editor – shows in the editor area.
Honored when opening the Commit Graph from the command palette.