Extension Settings

Git Graph Settings

This extension contributes the following settings:

Auto Center Commit Details View

Automatically center the commit details view when it is opened.

• Setting: git-graph.autoCenterCommitDetailsView
• Default: true
• Type: Boolean

Combine Local and Remote Branch Labels

Combine local and remote branch labels if they refer to the same branch, and are on the same commit.

• Setting: git-graph.combineLocalAndRemoteBranchLabels
• Default: true
• Type: Boolean

Commit Details View Location

Specifies where the Commit Details View is rendered in Git Graph view.

• Setting: git-graph.commitDetailsViewLocation
• Default: Inline
• Options:
  • Inline: Show the Commit Details View inline with the graph
  • Docked to Bottom: Show the Commit Details View docked to the bottom of the Git Graph view

Commit Ordering

Specifies the order of commits on the Git Graph view. See git log for more information on each order option.

• Setting: git-graph.commitOrdering
• Default: date
• Options:
  • date: Show commits in the commit timestamp order.
  • author-date: Show commits in the author timestamp order.
  • topo: Avoid showing commits on multiple lines of history intermixed.

Context Menu Actions Visibility

Customise which context menu actions are visible. For example, if you want to hide the rebase action from the branch context menu, a suitable value for this setting is { "branch": { "rebase": false } }.

• Setting: git-graph.contextMenuActionsVisibility
• Type: object

Click to show the default value of this configuration setting.

{
    "branch": {
        "checkout": true,
        "rename": true,
        "delete": true,
        "merge": true,
        "rebase": true,
        "push": true,
        "createPullRequest": true,
        "copyName": true
    },
    "commit": {
        "addTag": true,
        "createBranch": true,
        "checkout": true,
        "cherrypick": true,
        "revert": true,
        "drop": true,
        "merge": true,
        "rebase": true,
        "reset": true,
        "copyHash": true,
        "copySubject": true
    },
    "remoteBranch": {
        "checkout": true,
        "delete": true,
        "fetch": true,
        "pull": true,
        "createPullRequest": true,
        "copyName": true
    },
    "stash": {
        "apply": true,
        "createBranch": true,
        "pop": true,
        "drop": true,
        "copyName": true,
        "copyHash": true
    },
    "tag": {
        "viewDetails": true,
        "delete": true,
        "push": true,
        "copyName": true
    },
    "uncommittedChanges": {
        "stash": true,
        "reset": true,
        "clean": true,
        "openSourceControlView": true
    }
}

Custom Branch Glob Patterns

An array of Custom Branch Glob Patterns to be shown in the 'Branches' dropdown.

• Setting: git-graph.customBranchGlobPatterns
• Default: []
• Type: Array
• Example: [{"name": "Feature Requests", "glob": "heads/feature/*"}]

Custom Emoji Shortcode Mappings

An array of custom Emoji Shortcode mappings

• Setting: git-graph.customEmojiShortcodeMappings
• Default: []
• Type: Array
• Example: [{"shortcode": ":sparkles:", "emoji":"✨"}]

Custom Pull Request Providers

An array of custom Pull Request providers that can be used in the "Pull Request Creation" Integration. For information on how to configure this setting, see the documentation here.

• Setting: git-graph.customPullRequestProviders
• Default: []
• Type: Array
• Example: See the documentation here.

Date Format

Specifies the date format to be used in the "Date" column on the Git Graph View.

• Setting: git-graph.dateFormat
• Default: Date & Time
• Options:
  • Date & Time: Show the date and time, for example "24 Mar 2019 21:34"
  • Date Only: Show the date only, for example "24 Mar 2019"
  • ISO Date & Time: Show the ISO date and time, for example "2019-03-24 21:34"
  • ISO Date Only: Show the ISO date only, for example "2019-03-24"
  • Relative: Show relative times, for example "5 minutes ago"

Date Type

Specifies the date type to be displayed in the "Date" column on the Git Graph View.

• Setting: git-graph.dateType
• Default: Author Date
• Options:
  • Author Date: Use the author date of a commit
  • Commit Date: Use the committer date of a commit

Default Column Visibility

An object specifying the default visibility of the Date, Author & Commit columns. Each columns visibility is defined by a boolean, such that true => visible, and false => hidden.

• Setting: git-graph.defaultColumnVisibility
• Default: {"Date": true, "Author": true, "Commit": true}
• Type: Object
  • Date: boolean
  • Author: boolean
  • Commit: boolean

Default File View Type

Sets the default type of File View (Tree or List) used in the Commit Details / Comparison Views. This can be overridden per repository using the controls on the right side of the Commit Details / Comparison Views.

• Setting: git-graph.defaultFileViewType
• Default: File Tree
• Options:
  • File Tree: Display files in a tree structure
  • File List: Display files in a list (useful for repositories with deep folder structures)

Dialog Defaults

Set the default options on the following dialogs:

• Add Tag Dialog
  • Default state of the field indicating whether the tag should be pushed to a remote once it is added.
    • Setting: git-graph.dialog.addTag.pushToRemote
    • Default: false
    • Type: Boolean
  • Default type of the tag being added.
    • Setting: git-graph.dialog.addTag.type
    • Default: Annotated
    • Type: Annotated | Lightweight
• Apply Stash Dialog
  • Default state of the "Reinstate Index" checkbox.
    • Setting: git-graph.dialog.applyStash.reinstateIndex
    • Default: false
    • Type: Boolean
• Cherry Pick Dialog
  • Default state of the "Record Origin" checkbox.
    • Setting: git-graph.dialog.cherryPick.recordOrigin
    • Default: false
    • Type: Boolean
• Create Branch Dialog
  • Default state of the "Check out" checkbox.
    • Setting: git-graph.dialog.createBranch.checkOut
    • Default: false
    • Type: Boolean
• Delete Branch Dialog
  • Default state of the "Force Delete" checkbox.
    • Setting: git-graph.dialog.deleteBranch.forceDelete
    • Default: false
    • Type: Boolean
• Merge Dialog
  • Default state of the "No Commit" checkbox.
    • Setting: git-graph.dialog.merge.noCommit
    • Default: false
    • Type: Boolean
  • Default state of the "Create a new commit even if fast-forward is possible" checkbox.
    • Setting: git-graph.dialog.merge.noFastForward
    • Default: true
    • Type: Boolean
  • Default state of the "Squash Commits" checkbox.
    • Setting: git-graph.dialog.merge.squashCommits
    • Default: false
    • Type: Boolean
• Pop Stash Dialog
  • Default state of the "Reinstate Index" checkbox.
    • Setting: git-graph.dialog.popStash.reinstateIndex
    • Default: false
    • Type: Boolean
• Rebase Dialog
  • Default state of the "Ignore Date (non-interactive rebase only)" checkbox.
    • Setting: git-graph.dialog.rebase.ignoreDate
    • Default: true
    • Type: Boolean
  • Default state of the "Launch Interactive Rebase in new Terminal" checkbox.
    • Setting: git-graph.dialog.rebase.launchInteractiveRebase
    • Default: false
    • Type: Boolean
• Reset Current Branch to Commit Dialog
  • Default mode to be used for the reset action.
    • Setting: git-graph.dialog.resetCurrentBranchToCommit.mode
    • Default: Mixed
    • Type: Soft | Mixed | Hard
• Reset Uncommitted Changes Dialog
  • Default mode to be used for the reset action.
    • Setting: git-graph.dialog.resetUncommittedChanges.mode
    • Default: Mixed
    • Type: Mixed | Hard
• Stash Uncommitted Changes Dialog
  • Default state of the "Include Untracked" checkbox.
    • Setting: git-graph.dialog.stashUncommittedChanges.includeUntracked
    • Default: true
    • Type: Boolean

Fetch And Prune

Before fetching from remote(s) using the Fetch button on the Git Graph View Control Bar, remove any remote-tracking references that no longer exist on the remote(s).

• Setting: git-graph.fetchAndPrune
• Default: false (disabled)
• Type: Boolean

Fetch Avatars

Fetch avatars of commit authors and committers. By enabling this setting, you consent to commit author and committer email addresses being sent GitHub, GitLab or Gravatar, depending on the repositories remote origin.

• Setting: git-graph.fetchAvatars
• Default: false (disabled)
• Type: Boolean

File Encoding

The character set encoding used when retrieving a specific version of repository files (e.g. in the Diff View). A list of all supported encodings can be found here.

• Setting: git-graph.fileEncoding
• Default: utf8
• Type: String

Graph Colours

Specifies the colours used on the graph.

• Setting: git-graph.graphColours
• Default: ["#0085d9", "#d9008f", "#00d90a", "#d98500", "#a300d9", "#ff0000", "#00d9cc", "#e138e8", "#85d900", "#dc5b23", "#6f24d6", "#ffcc00" ]
• Type: Array of HEX or RGB colours

Graph Style

Specifies the style of the transitions between branches on the graph.

Rounded	Angular

• Setting: git-graph.graphStyle
• Default: rounded
• Options:
  • rounded: Use smooth curves when transitioning between branches on the graph
  • angular: Use angular lines when transitioning between branches on the graph

Initial Load Commits

Specifies the number of commits to initially load.

• Setting: git-graph.initialLoadCommits
• Default: 300
• Type: Positive Integer

Integrated Terminal Shell

Specifies the path and filename of the Shell executable to be used by the Visual Studio Code Integrated Terminal, when opened by Git Graph during Interactive Rebase's. For example, to use Git Bash on Windows this setting would commonly be set to C:\Program Files\Git\bin\bash.exe. If this setting is left blank, the default Shell is used.

• Setting: git-graph.integratedTerminalShell
• Default: ""
• Type: String
• For security reasons, this setting can only be specified in the User Settings, not in the Workspace Settings.

Load More Commits

Specifies the number of additional commits to load when the "Load More Commits" button is pressed, or more commits are automatically loaded.

• Setting: git-graph.loadMoreCommits
• Default: 100
• Type: Positive Integer

Load More Commits Automatically

When the view has been scrolled to the bottom, automatically load more commits if they exist (instead of having to press the "Load More Commits" button).

• Setting: git-graph.loadMoreCommitsAutomatically
• Default: true
• Type: Boolean

Max Depth Of Repo Search

Specifies the maximum depth of subfolders to search when discovering repositories in the workspace.

• Setting: git-graph.maxDepthOfRepoSearch
• Default: 0 (don't search subfolders)
• Type: Positive Integer

Note: Sub-repos are not automatically detected when searching subfolders, however they can be manually added by running the command "Git Graph: Add Git Repository" in the Command Palette.

Mute Commits that are not ancestors of HEAD

Display commits that aren't ancestors of the checked-out branch / commit with a muted text color. Muting will only occur if the commit referenced by HEAD is within the loaded commits on the Git Graph View.

• Setting: git-graph.muteCommitsThatAreNotAncestorsOfHead
• Default: false
• Type: Boolean

Mute Merge Commits

Display merge commits with a muted text color.

• Setting: git-graph.muteMergeCommits
• Default: true
• Type: Boolean

Open Diff Tab Location

Specifies which pane the Visual Studio Code Diff is opened in.

• Setting: git-graph.openDiffTabLocation
• Default: Active
• Options:
  • Active: Open Visual Studio Code Diff in the Active Pane
  • Beside: Open Visual Studio Code Diff beside the Active Pane

Open Repo to HEAD

When opening or switching repositories in the Git Graph View, automatically scroll the view to be centered on the commit referenced by HEAD. This will only occur if the commit referenced by HEAD is within the loaded commits on the Git Graph View.

• Setting: git-graph.openRepoToHead
• Default: false
• Type: Boolean

Open to the Repo of the Active Text Editor Document

Open the Git Graph View to the repository containing the active Text Editor document.

• Setting: git-graph.openToTheRepoOfTheActiveTextEditorDocument
• Default: false
• Type: Boolean

Reference Label Alignment

Specifies how branch and tag reference labels are aligned for each commit.

• Setting: git-graph.referenceLabelAlignment
• Default: Normal
• Options:
  • Normal: Show branch & tag labels on the left of the commit message in the 'Description' column.
  • Branches (on the left) & Tags (on the right): Show branch labels on the left of the commit message in the 'Description' column, and tag labels on the right.
  • Branches (aligned to the graph) & Tags (on the right): Show branch labels aligned to the graph in the 'Graph' column, and tag labels on the right in the 'Description' column.

Retain Context When Hidden

Specifies if the Git Graph view Visual Studio Code context is kept when the panel is no longer visible (e.g. moved to background tab). Enabling this setting will make Git Graph load significantly faster when switching back to the Git Graph tab, however has a higher memory overhead.

• Setting: git-graph.retainContextWhenHidden
• Default: true
• Type: Boolean

Show Commits Only Referenced By Tags

Show commits that are only referenced by tags in Git Graph.

• Setting: git-graph.showCommitsOnlyReferencedByTags
• Default: true
• Type: Boolean

Show Current Branch By Default

Show the current branch by default when Git Graph is opened.

• Setting: git-graph.showCurrentBranchByDefault
• Default: false
• Type: Boolean

Show Signature Status

Show the commit's signature status to the right of the Committer in the Commit Details View (only for signed commits). Hovering over the signature icon displays a tooltip with the signature details. Requires Git (>= 2.4.0) & GPG (or equivalent) to be installed on the same machine that is running Visual Studio Code.

• Setting: git-graph.showSignatureStatus
• Default: false
• Type: Boolean

Show Status Bar Item

Show a Status Bar item which opens Git Graph when clicked.

• Setting: git-graph.showStatusBarItem
• Default: true
• Type: Boolean

Show Tags

Show Tags in Git Graph by default. This can be overridden per repository in the Git Graph View's Repository Settings Widget.

• Setting: git-graph.showTags
• Default: true
• Type: Boolean

Show Uncommitted Changes

Show uncommitted changes (set to false to decrease load time on large repositories).

• Setting: git-graph.showUncommittedChanges
• Default: true
• Type: Boolean

Source Code Provider Integration Location

Specifies where the 'View Git Graph' action appears on the title of SCM Providers.

• Setting: git-graph.sourceCodeProviderIntegrationLocation
• Default: Inline
• Options:
  • Inline: Show the 'View Git Graph' action on the title of SCM Providers
  • More Actions: Show the 'View Git Graph' action in the 'More Actions...' menu on the title of SCM Providers

Tab Icon Colour Theme

Specifies the colour theme of the icon displayed on the Git Graph tab.

• Setting: git-graph.tabIconColourTheme
• Default: colour
• Options:
  • colour: Show a colour icon which suits most Visual Studio Code colour themes
  • 
  • grey: Show a grey icon which suits Visual Studio Code colour themes that are predominantly grayscale
  • 

Use Mailmap

Respect .mailmap files when displaying author & committer names and email addresses.

• Setting: git-graph.useMailmap
• Default: false
• Type: Boolean

Consumed Settings

This extension consumes the following settings:

Git: Path

Specifies the path of a portable Git installation.

• Setting: git.path
• Default: not set
• Type: String - Path and filename of the Git executable, for example C:\Program Files\Git\bin\git.exe on Windows