Using Git source control in VS Code https://code.visualstudio.

com/docs/sourcecontrol/overview

🚀 Get GitHub Copilot Free (vscode://github.copilot-chat?referrer=vscode-updatebanner) in VS

Code!
×

TOPICS Overview

IN THIS ARTICLE Working in a Git repository

(https://vscode.dev/github/microsoft/vscode-docs/blob/main/docs/sourcecontrol/overview.md)

Using Git source control in VS Code

Visual Studio Code has integrated source control management (SCM) and includes Git (https://git-
scm.com/) support out-of-the-box. Many other source control providers are available through extensions
on the Visual Studio Marketplace (https://marketplace.visualstudio.com/search?
target=VSCode&category=SCM%20Providers&sortBy=Installs).

With GitHub Copilot in VS Code, you can get suggestions for commit messages, pull requests, and review
code changes before committing them. Learn more about GitHub Copilot in VS Code (/docs/copilot/
overview).

Tip
If you don't have a Copilot subscription yet, use Copilot for free by signing up for the Copilot Free
plan (https://github.com/github-copilot/signup). You'll get a monthly limit of completions and chat
interactions.

1 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Using Git with Visual Studio Code (O6cial Beginner Tutorial)

Tip
If you're just getting started with Git, the git-scm (https://git-scm.com/doc) website is a good place to
start, with a popular online book (https://git-scm.com/book), Getting Started videos (https://git-
scm.com/video/what-is-git) and cheat sheets (https://github.github.com/training-kit/downloads/
github-git-cheat-sheet.pdf). The VS Code documentation assumes you are already familiar with Git.

Working in a Git repository

VS Code recognizes when you open a folder that is a Git repository. The Source Control view enables you
to perform most of the Git operations without using the command line.

Important
Make sure that Git is installed on your machine. VS Code uses your machine's Git installation (at
least version 2.0.0 ), so you need to install Git (https://git-scm.com/download) first before you get
these features.

You can access the Source Control view from the by selecting the Source Control icon in the Activity Bar
or by using the ⌃⇧G keyboard shortcut. If you have changes, the Source Control icon indicates how
many changes you currently have in your repository.

The Source Control view shows the details of your current repository changes: CHANGES, STAGED
CHANGES and MERGE CHANGES. You can also view the Source Control graph to see how your changes
relate to the repository's history.

2 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

When you select a file in the Source Control view, you will see the changes that you have made to that file
in a diff editor.

Tip
For unstaged changes, the editor on the right still lets you edit the file: feel free to use it!

You can also find indicators of the status of your repository in the bottom-left of the VS Code Status Bar:
the current branch, dirty indicators, and the number of incoming and outgoing commits of the current
branch. To check out any branch in your repository, select the status indicator and select the Git
reference from the list.

Tip
You can open VS Code in a sub-directory of a Git repository. VS Code's Git services will still work as
usual, showing all changes within the repository, but file changes outside of the scoped directory are
shaded with a tool tip indicating they are located outside the current workspace.

Cloning a repository

If you haven't opened a folder yet, the Source Control view will give you the options to Open Folder from
your local machine or Clone Repository.

3 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

If you select Clone Repository, you will be asked for the URL of the remote repository (for example on
GitHub (https://github.com/)) and the parent directory under which to put the local repository.

For a GitHub repository, you would find the URL from the GitHub Code dialog.

You would then paste that URL into the Git: Clone prompt.

You'll also see the option to Clone from GitHub. Once you authenticate with your GitHub account in VS
Code, you'll be able to search through repositories by name, and select any repo to clone it. You can also
start the flow to clone a Git repository with the Git: Clone command in the Command Palette ( ⇧⌘P ). To
see a step-by-step walkthrough, check out our Clone repos from VS Code (https://www.youtube.com/
watch?v=bz1KauFlbQI) video.

Note
If you'd like to work on a repository without cloning the contents to your local machine, you can install
the GitHub Repositories (https://marketplace.visualstudio.com/items?itemName=github.remotehub)
extension to browse and edit directly on GitHub. You can learn more in the GitHub Repositories
extension (/docs/sourcecontrol/github#_github-repositories-extension) section.

Initialize a repository

If your workspace is on your local machine, you can enable Git source control by creating a Git repository
with the Initialize Repository command. When VS Code doesn't detect an existing Git repository, the
Source Control view will give you the options to Initialize Repository or Publish to GitHub.

4 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

You can also run the Git: Initialize Repository and Publish to GitHub commands from the Command
Palette ( ⇧⌘P ).

• Initialize Repository: creates the necessary Git repository metadata files and shows your workspace
files as untracked changes ready to be staged.
• Publish to GitHub: directly publishes your workspace folder to a GitHub repository, allowing you to
choose between private and public repositories. Check out our publishing repos (https://
www.youtube.com/watch?v=3BBvBwDW4CY) video for more information about publishing to GitHub.

Commit

Staging ( git add ) and unstaging ( git reset ) can be done via contextual actions in the files or by
drag-and-drop.

Note

5 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Configure your Git username and email. When you commit, be aware that if your username and/or
email is not set in your Git configuration, Git will fall back to using information from your local
machine. You can find the details in Git commit information (https://git-scm.com/docs/git-
commit#_commit_information).

You can type a commit message above the changes and press Ctrl+Enter (macOS: ⌘+Enter ) to commit
them. If there are any staged changes, only those changes will be committed. Otherwise, you'll get a
prompt asking you to select what changes you'd like to commit and get the option to change your commit
settings.

We've found this to be a great workflow. For example, in the earlier screenshot, only the staged changes
to overview.png will be included in the commit. Later staging and commit actions could include the
changes to versioncontrol.md and the two other .png images as a separate commit.

More specific Commit actions can be found in the Views and More Actions ... menu on the top of the
Source Control view.

6 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Tip
If you commit your change to the wrong branch, undo your commit using the Git: Undo Last Commit
command in the Command Palette ( ⇧⌘P ).

Git: Commits in Visual Studio Code

Generate a commit message with AI

GitHub Copilot in VS Code can generate a commit message for you, based on the code changes you've
made. In the Source Control view, select the Generate Commit Message with Copilot button (!) in the
commit message input box.

If you have specific requirements for your commit message for your organization or project, you can use
Copilot custom instructions for generating commit messages. For example, commit messages have a
maximum length of 60 chars and should start with a verb in the present tense. Get more details about
Copilot custom instructions for generating commit messages (/docs/copilot/copilot-customization).

7 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Author commit messages using an editor

If you don't enter a commit message when committing changes, VS Code opens an editor for the
COMMIT_EDITMSG file where you can author the commit message in the editor. After you provide a commit
message, either close the editor tab, or select the Accept Commit Message button in the editor toolbar to
commit the changes.

To cancel the commit operation, you can either clear the contents of the text editor and close the editor
tab, or select the Discard Commit Message button in the editor toolbar.

You can disable this functionality by toggling the

" (vscode://settings/git.useEditorAsCommitInput)git.useEditorAsCommitInput setting. After the setting is
changed, you have to restart VS Code for the change to take effect.

To use the same flow for git commit commands executed in the integrated terminal, enable the
" (vscode://settings/git.terminalGitEditor)git.terminalGitEditor setting.

Git blame information

VS Code can show git blame information inline in the editor and in the Status Bar. Hover over the Status
Bar item or inline hint to view detailed git blame information.

8 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

To enable or disable git blame information, use the Git: Toggle Git Blame Editor Decoration and Git:
Toggle Git Blame Status Bar Item commands, or configure these settings:

• " (vscode://settings/git.blame.statusBarItem.enabled)git.blame.statusBarItem.enabled (enabled

by default)
• " (vscode://settings/git.blame.editorDecoration.enabled)git.blame.editorDecoration.enabled

You can customize the format of the message that is shown in the editor and in the Status Bar with the
" (vscode://settings/git.blame.editorDecoration.template)git.blame.editorDecoration.template and

" (vscode://settings/git.blame.statusBarItem.template)git.blame.statusBarItem.template settings. You

can use variables for the most common information.

For example, the following template shows the subject of the commit, the author's name, and the author's
date relative to now:

{ Copy
"git.blame.editorDecoration.template": "${subject}, ${authorName} (${authorDateAg
o})"
}

To adjust the color of the editor decoration, use the git.blame.editorDecorationForeground theme
color.

9 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Review uncommitted code changes with AI

GitHub Copilot in VS Code can help you review your uncommitted code changes.

1 In the Source Control view, select the Copilot Code Review button to start a code review of the
uncommitted changes

2 Copilot generates code review comments and suggestions as overlays in the editor

10 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

You can also view a list of all code review comments in the Comments panel.

3 You apply or discard suggestions by using the corresponding buttons, or context menu actions in
the Comments panel

Get more details about reviewing code changes with Copilot (https://docs.github.com/en/copilot/using-
github-copilot/code-review/using-copilot-code-review?tool=vscode) in the GitHub documentation.

Branches and Tags

Git: branches in Visual Studio Code

You can create and checkout branches directly within VS Code through the Git: Create Branch and Git:
Checkout to commands in the Command Palette ( ⇧⌘P ).

If you run Git: Checkout to, you will see a dropdown list containing all of the branches or tags in the
current repository. It will also give you the option to create a new branch if you decide that's a better
option, or checkout a branch in detached mode.

11 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

The Git: Create Branch command lets you quickly create a new branch. Just provide the name of your
new branch and VS Code will create the branch and switch to it. If you choose to Create new branch
from..., you'll get an extra prompt that allows you to specify which commit the new branch should be
pointing to.

Tip
VS Code can automatically save and restore open editors when you switch to another branch. Use the
" (vscode://settings/scm.workingSets.enabled)scm.workingSets.enabled setting to enable this
feature. To control the open editors when switching to a branch for the first time, you can use the
" (vscode://settings/scm.workingSets.default)scm.workingSets.default setting.

Remotes

Given that your repository is connected to some remote and that your checked out branch has an
upstream link (https://git-scm.com/book/ch3-5.html) to a branch in that remote, VS Code offers you useful
actions to push, pull, and sync that branch (the latter will run a pull command followed by a push
command). You can find these actions in the Views and More Actions ... menu, along with the option to
add or remove a remote.

VS Code is able to periodically fetch changes from your remotes. This enables VS Code to show how many
changes your local repository is ahead or behind the remote. This feature is disabled by default and you
can use the " (vscode://settings/git.autofetch)git.autofetch setting (/docs/editor/settings) to enable it.

Tip
You should set up a credential helper (https://docs.github.com/get-started/getting-started-with-git/
caching-your-github-credentials-in-git) to avoid getting asked for credentials every time VS Code
talks to your Git remotes. If you don't do this, you may want to consider disabling automatic fetching
via the " (vscode://settings/git.autofetch)git.autofetch setting (/docs/editor/settings) to reduce the
number of prompts you get.

Source Control Graph

When you have a remote repository configured, you can see how many commits you are ahead or behind
the remote. The Source Control Graph section of the Source Control view shows a graphical
representation of the commits that are incoming and outgoing.

The graph contains the current branch, the current branch's upstream branch, and an optional base
branch. The root of the graph is the common ancestor of these branches.

12 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

The graph provides the following functionality:

• Select an entry to see the corresponding changes in the commit.

• Perform Fetch, Pull, and Push actions by hovering over the Incoming/Outgoing heading.

Git Status Bar actions

There is a Synchronize Changes action in the Status Bar, next to the branch indicator, when the current
checked out branch has an upstream branch configured. Synchronize Changes will pull remote changes
down to your local repository and then push local commits to the upstream branch.

If there is no upstream branch configured and the Git repository has remotes set up, the Publish action is
enabled. This will let you publish the current branch to a remote.

13 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Gutter indicators

If you open a folder that is a Git repository and begin making changes, VS Code will add useful annotations
to the gutter and to the overview ruler.

• A red triangle indicates where lines have been deleted

• A green bar indicates new added lines
• A blue bar indicates modified lines

Merge conflicts

14 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Merge conflicts are recognized by VS Code. Differences are highlighted and there are inline actions to
accept either one or both changes. Once the conflicts are resolved, stage the conflicting file so you can
commit those changes.

3-way merge editor

To help you resolve merge conflicts, VS Code provides a 3-way merge editor where you can interactively
accept incoming and current changes and view and edit the resulting merged file. The 3-way merge editor
is opened by selecting the Resolve in Merge Editor button in the bottom right corner of a file with Git
merge conflicts.

The 3-way merge editor displays separate views for Incoming changes (on the left), Current changes (on
the right), and the Result of the merge (at the bottom). Conflicts are highlighted and can be resolved by
using the CodeLens buttons.

Resolving conflicts
The 3-way merge editor allows you to resolve conflicts by accepting either one or both changes. You can

15 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

also manually edit the result of the merge.

For some conflicts, the merge editor shows an Accept Combination button. Accepting the combination
resolves the current conflict by smartly merging both changes. This is especially useful for changes in the
same line that don't touch the same characters.

Use the Ignore buttons to accept neither the incoming nor current change, but mark the conflict as
resolved. This resets the conflicting area to the state before any changes were made.

Completing the merge

You can use the conflict counter in the right of the result editor to keep track of how many unresolved
conflicts are remaining. Clicking on the counter jumps to the next unresolved conflict. Once all conflicts
are resolved, you can complete the merge by selecting Complete Merge in the bottom right corner. This
stages the file and closes the merge editor.

Alternative layouts and more

Selecting the three dots (···) in the top right corner of the merge editor opens a context menu with
additional options. You can switch to a vertical layout and display the base view, which shows the state of
the file before any changes were made.

The three dots next to Incoming, Current, and Result offer options for each view, such as showing a side-
by-side diff against base, accepting all changes, or resetting the result.

Understanding conflicts
If you want to learn more about the details of how 3-way merge editors work, we can recommend the
following video:

16 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

The EXTREMELY helpful guide to merge con8icts

Viewing diffs

Our Git tooling supports viewing of diffs within VS Code.

The Diff editor has a separate gutter in the middle, which enables you to Stage or Revert changes code
blocks. If you select a block of text, you can revert or stage the changes that are included in the selection.

17 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Tip
You can diff any two files by first right-clicking on a file in the Explorer view and selecting Select for
Compare and then right-click on the second file to compare with and select Compare with Selected.
Alternatively, open the Command Palette ( ⇧⌘P ), and select ay of the File: Compare commands.
Learn more about the different options to compare files in VS Code (/docs/editor/
codebasics#_compare-files).

Accessible Diff Viewer

There is an Accessible Diff Viewer in the Diff editor that presents changes in a unified patch format. You
can navigate between changes with Go to Next Difference ( F7 ) and Go to Previous Difference ( ⇧F7 ).
Lines can be navigated with arrow keys and pressing Enter will jump back in the Diff editor and the
selected line.

18 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Note
This experience is especially helpful for screen reader users.

Timeline view

The Timeline view, accessible at the bottom of the File Explorer by default, is a unified view for visualizing
time-series events (for example, Git commits) for a file.

VS Code's built-in Git support provides the Git commit history of the specified file. Selecting a commit will
open a diff view of the changes introduced by that commit. When you right-click on a commit, you'll get
options to Copy Commit ID and Copy Commit Message.

Visual Studio Code supports more Git history workflows through extensions (/docs/editor/extension-
marketplace) available on the VS Code Marketplace.

GitLens — Git supe… Git History Git Graph Git History Diff
eamodio 39.0M donjayamanne 13.5M mhutchie 10.6M huizhou 798.2K

(https:// (https:// (https:// (https://

19 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

marketplace.visualstudio marketplace.visualstudio marketplace.visualstudio marketplace.visualstudio

.com/items? .com/items? .com/items? .com/items?
itemName=eamodio.gitl itemName=donjayamann itemName=mhutchie.git itemName=huizhou.gith
ens) e.githistory) -graph) d)

Tip
Click on an extension tile to read the description and reviews in the Marketplace.

Git output window

You can always peek under the hood to see the Git commands we are using. This is helpful if something
strange is happening or if you are just curious. :)

To open the Git output window, run View > Output and select Log (Git) from the dropdown list.

VS Code as Git editor

When you launch VS Code from the command line, you can pass the --wait argument to make the
launch command wait until you have closed the new VS Code instance. This can be useful when you
configure VS Code as your Git external editor so Git will wait until you close the launched VS Code
instance.

Here are the steps to do so:

1 Make sure you can run code --help from the command line and you get help.
◦ if you do not see help, please follow these steps:
▪ macOS: Select Shell Command: Install 'Code' command in path from the Command
Palette.
▪ Windows: Make sure you selected Add to PATH during the installation.
▪ Linux: Make sure you installed Code via our new .deb or .rpm packages.

2 From the command line, run git config --global core.editor "code --wait"

Now you can run git config --global -e and use VS Code as editor for configuring Git.

VS Code as Git difftool and mergetool

You can use VS Code's diff and merge capabilities even when using Git from command-line. Add the
following to your Git configurations to use VS Code as the diff and merge tool:

20 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

[diff] Copy
tool = default-difftool
[difftool "default-difftool"]
cmd = code --wait --diff $LOCAL $REMOTE
[merge]
tool = code
[mergetool "code"]
cmd = code --wait --merge $REMOTE $LOCAL $BASE $MERGED

This uses the --diff option that can be passed to VS Code to compare two files side by side. The merge
tool will be used the next time Git discovers a merge conflict.

To summarize, here are some examples of where you can use VS Code as the editor:

• git rebase HEAD~3 -i do interactive rebase using VS Code

• git commit use VS Code for the commit message
• git add -p followed by e for interactive add
• git difftool <commit>^ <commit> use VS Code as the diff editor for changes

Working with GitHub Pull Requests and Issues

Visual Studio Code can also bring in GitHub's pull requests and issues. Create your PRs in VS Code, review
with comments, and approve them without switching context. Learn more about GitHub PRs and Issues in
VS Code (/docs/sourcecontrol/github).

SCM Providers

Git Extension Pack SVN Hg Perforce for VS Co…

donjayamanne 2.7M johnstoncode 1.2M mrcrowl 134.1K slevesque 69.0K

(https:// (https:// (https:// (https://

marketplace.visualstudio marketplace.visualstudio marketplace.visualstudio marketplace.visualstudio
.com/items? .com/items? .com/items? .com/items?
itemName=donjayamann itemName=johnstoncod itemName=mrcrowl.hg) itemName=slevesque.pe
e.git-extension-pack) e.svn-scm) rforce)

21 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Tip
Click on an extension tile to read the description and reviews in the Marketplace.

VS Code has support for handling multiple Source Control providers simultaneously. For example, you can
open multiple Git repositories alongside your Azure DevOps Server local workspace and seamlessly work
across your projects. To turn on the Source Control Providers view, select the overflow menu in the
Source Control view ( ⌃⇧G ), hover over Views, and make sure that Source Control Repositories is
marked with a check. The Source Control Providers view shows the detected providers and repositories,
and you can scope the display of your changes by selecting a specific provider.

SCM Provider extensions

If you would like to install another SCM provider, you can search on the scm providers extension category
in the Extensions view ( ⇧⌘X ). Start typing '@ca' and you will see suggestions for extension categories
like debuggers and linters. Select @category:"scm providers" to see available SCM providers.

22 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Next steps

• Intro Video - Git Version Control (/docs/introvideos/versioncontrol) - An introductory video providing

an overview of VS Code Git support.

• Intro to collaborating on GitHub (/docs/sourcecontrol/github) - Learn how to use GitHub with VS

Code.

• Learn more about Copilot VS Code (/docs/copilot/overview) - Learn about Copilot in VS Code.

• Source Control API (/api/extension-guides/scm-provider) - If you want to integrate another Source

Control provider into VS Code, see our Source Control API.

Was this documentation helpful?

Yes No

02/06/2025

Subscribe(/feed.xml) Ask questions(https://stackoverflow.com/questions/tagged/vscode)

Follow @code(https://go.microsoft.com/fwlink/?LinkID=533687)

Request features(https://go.microsoft.com/fwlink/?LinkID=533482)

23 sur 24 19/02/2025 20:30

Using Git source control in VS Code https://code.visualstudio.com/docs/sourcecontrol/overview

Report issues(https://www.github.com/Microsoft/vscode/issues)

Watch videos(https://www.youtube.com/channel/UCs5Y5_7XK8HLDX0SLNwkd3w)

(https://
www.microsoft.com)

(https://go.microsoft.com/fwlink/?LinkID=533687)
(https://github.com/microsoft/vscode) (https://www.youtube.com/@code)

Support (https://support.serviceshub.microsoft.com/supportforbusiness/create?sapId=d66407ed-3967-
b000-4cfb-2c318cad363d)
Privacy (https://go.microsoft.com/fwlink/?LinkId=521839)
Terms of Use (https://www.microsoft.com/legal/terms-of-use) License (/License)

24 sur 24 19/02/2025 20:30