-
Notifications
You must be signed in to change notification settings - Fork 301
Extension Settings
This extension contributes the following settings:
Automatically center the commit details view when it is opened.
- Setting:
git-graph.autoCenterCommitDetailsView
- Default:
true
- Type: Boolean
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
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
-
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.
-
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/*"}]
An array of custom Emoji Shortcode mappings
- Setting:
git-graph.customEmojiShortcodeMappings
- Default:
[]
- Type: Array
- Example:
[{"shortcode": ":sparkles:", "emoji":"✨"}]
Specifies the date format to be used in the date column of the graph.
- Setting:
git-graph.dateFormat
- Default:
Date & Time
- Options:
-
Date & Time
: Show the date and time, for example "19 Mar 2019 21:34" -
Date Only
: Show the date only, for example "19 Mar 2019" -
Relative
: Show relative times, for example "5 minutes ago"
-
Specifies the date type to be displayed throughout Git Graph, either the author or commit date.
- 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
-
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
-
Set the default options on the following dialogs:
- Add Tag Dialog
- Default type of the tag being added.
- Setting:
git-graph.dialog.addTag.type
- Default:
Annotated
- Type:
Annotated
|Lightweight
- Setting:
- Default type of the tag being added.
- Create Branch Dialog
- Default state of the "Check out" checkbox.
- Setting:
git-graph.dialog.createBranch.checkOut
- Default:
false
- Type: Boolean
- Setting:
- Default state of the "Check out" checkbox.
- Merge Dialog
- 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
- Setting:
- Default state of the "Squash commits" checkbox.
- Setting:
git-graph.dialog.merge.squashCommits
- Default:
false
- Type: Boolean
- Setting:
- Default state of the "Create a new commit even if fast-forward is possible" checkbox.
- Rebase Dialog
- Default state of the "Ignore Date (non-interactive rebase only)" checkbox.
- Setting:
git-graph.dialog.rebase.ignoreDate
- Default:
true
- Type: Boolean
- Setting:
- Default state of the "Launch Interactive Rebase in new Terminal" checkbox.
- Setting:
git-graph.dialog.rebase.launchInteractiveRebase
- Default:
false
- Type: Boolean
- Setting:
- Default state of the "Ignore Date (non-interactive rebase only)" checkbox.
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 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
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
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
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
-
Specifies the number of commits to initially load.
- Setting:
git-graph.initialLoadCommits
- Default:
300
- Type: Positive Integer
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.
Specifies the number of commits to load when the "Load More Commits" button is pressed (only shown when more commits are available).
- Setting:
git-graph.loadMoreCommits
- Default:
100
- Type: Positive Integer
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.
Show merge commits with a muted text color.
- Setting:
git-graph.muteMergeCommits
- Default:
true
- Type: Boolean
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 Git Graph to the repository containing the active Text Editor document.
- Setting:
git-graph.openToTheRepoOfTheActiveTextEditorDocument
- Default:
false
- Type: Boolean
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.
-
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 the current branch by default when Git Graph is opened. Default: false (show all branches)
- Setting:
git-graph.showCurrentBranchByDefault
- Default:
false
- Type: Boolean
Show a Status Bar item which opens Git Graph when clicked.
- Setting:
git-graph.showStatusBarItem
- Default:
true
- Type: Boolean
Show uncommitted changes (set to false to decrease load time on large repositories).
- Setting:
git-graph.showUncommittedChanges
- Default:
true
- Type: Boolean
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
-
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
-
Respect .mailmap files when displaying author & committer names and email addresses.
- Setting:
git-graph.useMailmap
- Default:
false
- Type: Boolean
This extension consumes the following settings:
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
If you have any questions about the content of this page, or anything related to Git Graph, please chat with us on Discord!
General Information:
Release Information:
Contributing Information:
If you have any questions about Git Graph, please chat with us on Discord!