Repository files navigation

Notice: With the release of VFS for Git 2.32, VFS for Git is in maintenance mode. Only required updates as a reaction to critical security vulnerabilities will prompt a release.

Branch	Unit Tests	Functional Tests	Large Repo Perf	Large Repo Build
master
shipped

VFS stands for Virtual File System. VFS for Git virtualizes the file systembeneath your Git repository so that Git and all tools see what appears to be aregular working directory, but VFS for Git only downloads objects as theyare needed. VFS for Git also manages the files that Git will consider, toensure that Git operations such asstatus,checkout, etc., can be as quickas possible because they will only consider the files that the user hasaccessed, not all files in the repository.

Note: for new deployments, we strongly recommend you considerScalar instead of VFS for Git. Bycombining the lessons from operating VFS for Git at scale with new developmentsin Git, Scalar offers a clearer path forward for all large monorepos.

VFS for Git requires Windows 10 Anniversary Update (Windows 10 version 1607) or later.

To install, usewinget to install themicrosoft/git fork of Git and VFS for Gitusing:

winget install --id Microsoft.Gitwinget install --id Microsoft.VFSforGit

You will need to continue using themicrosoft/git version of Git, and itwill notify you when new versions are available.

If you'd like to build your own VFS for Git Windows installer:

• Install Visual Studio 2022 Community Edition or higher (https://www.visualstudio.com/downloads/).
  • Include the following workloads:
    • .NET desktop development
    • Desktop development with C++
    • .NET Core cross-platform development
  • Include the following additional components:
    • .NET Core runtime
    • Windows 10 or 11 SDK (10.0+)
• Install the .NET Core 8 SDK (https://www.microsoft.com/net/download/dotnet-core/8)
• Installnuget.exe
• Create a folder to clone into, e.g.C:\Repos\VFSForGit
• Clone this repo into thesrc subfolder, e.g.C:\Repos\VFSForGit\src
• Run\src\Scripts\BuildGVFSForWindows.bat
• You can also build in Visual Studio by openingsrc\GVFS.sln (do not upgrade any projects) and building. However, the very firstbuild will fail, and the second and subsequent builds will succeed. This is because the build requires a prebuild code generation step.For details, see the build script in the previous step.

Visual Studio 2022 willautomatically prompt you to install these dependencies when you open the solution. The .vsconfig file that is present in the root of the repository specifies all required components.

The installer can now be found atC:\Repos\VFSForGit\BuildOutput\GVFS.Installer.Windows\bin\x64\[Debug|Release]\SetupGVFS.<version>.exe

• VFS for Git requires a Git service that supports theGVFS protocol. For example, you can create a repo inAzure DevOps, and pushsome contents to it. There are two constraints:
  • Your repo must not enable any clean/smudge filters
  • Your repo must have a.gitattributes file in the root that includes the line* -text
• gvfs clone <URL of repo you just created>
  • Please choose theClone with HTTPS option in theClone Repository dialog in Azure Repos, notClone with SSH.
• cd <root>\src
• Run Git commands as you normally would
• gvfs unmount when done

This project was formerly known as GVFS (Git Virtual File System). You may occasionallysee collateral, including code and protocol names, which refer to the previous name.

The VFS for Git source code in this repo is available under the MIT license.SeeLicense.md.

VFS for Git relies on the PrjFlt filter driver, formerly known as the GvFltfilter driver, available as a prerelease NuGet package.