README.md

Introduction

git-tfs is a two-way bridge between TFS (Team Foundation Server) and git, similar to git-svn. It fetches TFS commits into a git repository, and lets you push your updates back to TFS.

The most recent version is 0.19.2. See the change history for details.

If you're having problems, check out the troubleshooting page. And read how to report an issue, before doing so ;)

Get git-tfs

Three differents ways to get git-tfs:

• Download a binary. Find it on the release page,
• Using Chocolatey. If Chocolatey is already installed on your computer, run cinst gittfs to install the Chocolatey package
• Build from source code. See §Building for more informations...

Whatever the way you get git-tfs, you should have git-tfs.exe in your path (and git, too).

Add the git-tfs folder path to your PATH. You could also set it temporary (the time of your current terminal session) using :

set PATH=%PATH%;%cd%\GitTfs\bin\Debug

Use git-tfs

You need .NET 4 and either the 2008, 2010 or 2012 version of Team Explorer installed.

Help

#lists the available commands
git tfs help

#shows a summary of the usage of a given command
git tfs help <command>

Cloning

# [optional] find a tfs repository path to clone :
git tfs list-remote-branches http://tfs:8080/tfs/DefaultCollection

# clone the whole repository (wait for a while...) :
git tfs clone http://tfs:8080/tfs/DefaultCollection $/some_project

# or, if you're impatient (and want to work from the last changeset) :
git tfs quick-clone http://tfs:8080/tfs/DefaultCollection $/some_project

# or, if you're impatient (and want a specific changeset) :
git tfs quick-clone http://tfs:8080/tfs/DefaultCollection $/some_project -c=145

Working

cd some_project
git log # shows your TFS history, unless you did quick-clone
tf history # error: no workspace ;)

# [do work, do work, just using git], then...
# gets latest from TFS to the branch tfs/default :
git tfs fetch

Checkin

# report all the commits on TFS :
git tfs rcheckin

# or commit using the tfs checkin window
git tfs checkintool 

# or commit with a message
git tfs checkin -m "Did stuff"

# or shelve your changes :
git tfs shelve MY_AWESOME_CHANGES

You could find more interesting use cases on how to use git-tfs.

git-tfs is designed to work outside of any existing TFS workspaces.

Available commands / options

This is the complete list of commands in the master branch on github.

Repository setup

• list-remote-branches - since 0.17
• clone - since 0.9
• quick-clone - since 0.9
• bootstrap - since 0.11
• init - since 0.9

Pull from TFS

• clone - since 0.9
• fetch - since 0.9
• pull - since 0.9
• quick-clone - since 0.9
• unshelve - since 0.11
• shelve-list - since 0.12
• init-branch - since v0.16 (prefer the branch command)
• labels - since v0.17

Push to TFS

• rcheckin - since 0.12
• checkin - since 0.10
• checkintool - since 0.10
• shelve - since 0.9

Manage TFS branches

• list-remote-branches - since 0.17
• branch - since 0.17
• init-branch - since v0.16 (prefer the branch command)

Other

• info
• cleanup - since 0.10
• cleanup-workspaces - since 0.10
• diagnostics - since 0.9
• help - since 0.9
• verify - since 0.11
• autotag option - since 0.12
• subtree - since 0.19
• reset-remote - since 0.19

Building

Prerequisites

• MSBuild (included in .NET 4)

And depending of the version of TFS you use :

• Visual Studio 2012 SDK
• Visual Studio 2010 SDK
• Visual Studio 2008 SDK

Get the source code and build

#get the source code
git clone --recursive git://github.com/git-tfs/git-tfs.git
cd git-tfs

#building with MSBuild (with the default configuration)
msbuild GitTfs.sln

#or building with MSBuild in debug
msbuild GitTfs.sln /p:Configuration=debug

#or building with MSBuild in release
msbuild GitTfs.sln /p:Configuration=release

#or with Rake (Ruby)
rake build:debug

Note : if the build fails because it can't find libgit2sharp dependency, update submodules with git submodule update

Contributing

Contributions are always welcome.

There are some simple guidelines.

Especially, don't forget to set core.autocrlf to true. (git config core.autocrlf true)

Migrations

If you're migrating a TFS server from 2008 or 2005 to 2010, you might want to Specify Alternate TFS URLs.

If you have questions or suggestions about how we could improve git-tfs you could go to google group.

Example of setting up central git repository that tracks TFS automatically.

Community

#git-tfs on FreeNode, and the mailing list

Thanks to travis-ci and jetbrains (teamcity) for providing CI!