Installing the Team Foundation Server Plug-in and the Command-line Client

You can use Team Explorer Everywhere and Visual Studio Team Foundation Server as part of your development processes with Eclipse to track work items, provide version control, and automate builds. You must install either the Team Foundation Server plug-in for Eclipse or the Cross-platform Command-Line Client for Team Foundation Server before you can use those features.

In this topic

Prerequisites

You must install a supported version of Eclipse, which you can obtain from the following website: Eclipse.org home. For more information about the Update Manager in Eclipse 3.4, see the following page on the Teamprise website: TKB00096 Installing Teamprise Plug-in for Eclipse using the Update Manager (Eclipse 3.4 and earlier).

Hardware requirements:

  • 1 GHz or faster processor

  • 1 GB RAM or more

  • 1 GB of available hard-disk space

    A portion of this disk space will be freed after installation if the original download package is removed from the hard disk.

Operating system requirements:

  • Windows XP with Service Pack 2, Windows Vista, or Windows 7 (x86, x64)

  • Linux with GLIBC 2.3 to 2.11 (x86, x86_64, PowerPC)

  • Mac OS X 10.4 to 10.6 (PowerPC, Intel)

  • Solaris 8, 9, 10 (SPARC, x86, x86-64)

  • AIX 5.2 to 6.1 (POWER)

  • HP-UX 11i v1 to v3 (PA-RISC, Itanium)

Integrated development environment (IDE) requirements:

  • Eclipse 3.2 to 3.7 on Windows, Linux, Mac OS X, Solaris, AIX, or HP-UX

  • IBM Rational Application Developer 7.0 to 7.5

  • Additional IDEs based on Eclipse 3.2 to 3.7 are supported, including Adobe Flex Builder 3 and Aptana Studio 2.0.

Java runtime requirements:

  • Sun Java 1.5 to 6 or IBM Java 1.5 to 6 on Windows

  • Apple Java 1.5 to 6 on Mac OS X

  • Sun Java 1.5 to 6 on Linux or Solaris

  • IBM Java 1.5 to 6 on Linux or AIX

  • Hewlett-Packard Java 1.5 to 6 on HP-UX

Team Foundation Server requirements:

  • Visual Studio Team Foundation Server 2010

  • Visual Studio Team System 2008 Team Foundation Server

  • Visual Studio 2005 Team Foundation Server

Install the Team Foundation Server Plug-in For Eclipse

You must install the plug-in before you can use it in your development processes. Follow the steps in this procedure to install it.

Note

It is not recommended to run the Team Foundation Server plug-in for Eclipse and the Teamprise plug-in in a side-by-side configuration. However, you might decide to do so while you evaluate the features of the Team Foundation Server plug-in for Eclipse.

To install the plug-in

  1. Open Eclipse.

    Note

    These installation instructions assume that you have Eclipse 3.5. On other versions of Eclipse, the steps might have different menu items, but the process is the same.

  2. On the Help menu, click Install New Software.

    The Install dialog box appears.

  3. Click Add.

    The Add Site dialog box appears.

  4. In Name, type Local Team Explorer plug-in archive, and then click Archive.

  5. Specify the location of the archive file on the product media of this procedure, and then click Open.

    You can find the archive file TFSEclipsePlugin-UpdateSiteArchive-10.0.0zip in the \PluginForEclipse folder on the product media, or you can download the most recent version from the following page on the Microsoft website: Microsoft Visual Studio Team Explorer Everywhere 2010 with SP1.

  6. In the Open dialog box, click OK.

  7. In the list of features in the Install dialog box, select the check box that corresponds to Team Explorer Everywhere, and then click Next two times.

  8. Accept the Microsoft Software License Terms, and then click Next.

  9. Select the Use a full-featured trial version of Microsoft Visual Studio Team Explorer Everywhere check box, and then click Finish.

    You must restart Eclipse when prompted.

Update Associations for Projects to use the Team Foundation Server Plug-in for Eclipse

You must remove the project association and then reestablish the association by sharing the project into an existing workspace for Team Foundation Server.

To remove associations

  1. In Project Explorer or Package Explorer, right-click a project for which you want to remove an association, point to Team, and click Disconnect Project Permanently.

  2. Click OK in the confirmation dialog box.

    Warning

    Do not delete the working folder mappings from your workspace.

To associate your local Eclipse workspace with the same Team Foundation Server workspace

  1. In Project Explorer, right-click the project that you want to add to version control, point to Team, and then click Share Project.

    The Share Project dialog box appears.

  2. In the Select a repository type list, click Team Foundation Server, and then click Next.

    The Team Project page of the Share Project to Team Foundation Server dialog box appears.

  3. In the list of servers, click the instance of Team Foundation Server to which you want to connect.

    If your server is not listed, click Servers, and then add the instance of Team Foundation Server to which you want to connect.

  4. In the Team Project Collections list, click the team project collection that contains the team project to which you want to add your project.

  5. In the Team Projects list, select the check box that corresponds to the team project to which you want to add your project, and then click Next to advance to the TFS Workspace page.

  6. In the list, click the Team Foundation Server workspace to which your project was previously connected, and then click Next.

    Note

    When you specify the workspace for Team Foundation Server with which your local project was previously associated, a new association is formed. This process does not add another copy of your project to version control.

  7. Review the summary information, and if it is correct, click Finish.

    You can click Back to return to previous steps and make changes.

    The project in your local workspace is associated with the version of the project that is under version control in Team Foundation Server.

    By default, Team Explorer does not appear. For more information about how to display Team Explorer, see Open Team Explorer.

Uninstall the Teamprise Plug-in

After you have installed the Team Foundation Server plug-in for Eclipse, you might decide to uninstall the Teamprise plug-in.

To uninstall the Teamprise Plug-in

  1. Open Eclipse.

  2. On the Help menu, click About Eclipse SDK.

    Note

    On other operating systems, you might need to perform different steps to open the About Eclipse dialog box. For example, on Mac OS X, you must instead click the Eclipse icon.

  3. Click the Installation Details button.

    The Eclipse SDK Installation Details dialog box appears.

  4. Click the Installed Software tab.

  5. Highlight both Teamprise Team Provider and Teamprise Standard Check-in Policy Plug-ins, and then click Uninstall.

  6. Restart Eclipse when prompted.

Install the Cross-platform Command-line Client for Team Foundation Server

You can perform many version control operations from the Cross-platform Command-Line Client for Team Foundation Server. Before you can use this client, you must install it and configure your shell or system path to include the installation folder.

To install the Cross-Platform Command-Line Client for Team Foundation Server

  1. Unzip the archive (.zip file) that contains the client.

  2. Configure your shell or system path to include the folder to which you unzipped the archive.

  3. To verify that the client is working, at a command prompt, type tf, and then press ENTER.

    If the client is correctly installed, output that starts with Team Explorer Everywhere appears.

  4. For information about any of the commands, you can type tf help Command, where Command is the name of the command for which you want information. For example, you could type tf help checkin.

Displaying Languages Other Than English

By installing the language pack for Team Explorer Everywhere 2010, you can display the plug-in and the command-line client in the following languages:

  • French

  • German

  • Japanese

Prerequisites

Before you install the language pack, you must install Team Explorer Everywhere 2010 Service Pack 1, install the appropriate product language pack for Eclipse, and configure the language pack for Eclipse to use the language pack for Team Explorer Everywhere. For more information about how to download and configure product language packs for Eclipse, see the following page on the Eclipse website: Eclipse Babel Project.

Changing the Language of the Plug-in

If you install the language pack and specify a language that it supports, you can display some user-interface text in that language. If a particular message is not available for the language that you specified, the message appears in English.

To install the language pack for Team Explorer Everywhere, take the following steps:

  1. Open Eclipse.

    Note

    These instructions reflect Eclipse 3.5. For other versions of Eclipse, the steps might have different menu items, but the process is the same.

  2. On the Help menu, click Install New Software.

    The Install dialog box appears.

  3. Click Add.

    The Add Site dialog box appears.

  4. In Name, type Local Team Explorer Everywhere Language Pack archive, and then click Archive.

  5. Specify the location of the archive file, and click Open.

    Select the check box for the downloaded archive file TFSEclipsePlugin-NL1-UpdateSiteArchive-10.1.0.zip, and then click OK.

    The Install dialog box appears.

  6. In the list of features, select the check box for Team Explorer Everywhere, and then click Next two times.

  7. Accept the Microsoft Software License Terms, and then click Finish.

  8. Restart Eclipse when prompted.

Changing the Language of the Command-line Client

You can display the Cross-platform Command-Line Client for Team Foundation Server if you install the language pack and configure Locale-specific environment variables for the appropriate language and character encoding. You must also configure your terminal program to display characters in this encoding.

To install the language pack for the command-line client, take the following steps:

  1. Unzip the archive file (TEE-CLC-NL1-10.1.0.zip) into the same location as the command-line client.

    Note

    The archive file contains a single com.microsoft.tfs.client.clc.nl1.jar file, which is extracted to the /lib directory inside the installation of the command-line client. To verify that the installation has been successful, confirm that this file is in the directory of your installation.

Troubleshooting Installation Issues

You can find information in this section about the following issues:

Errors when Uninstalling the Teamprise Plug-in

An error might appear when you uninstall the Teamprise plug-in if you did not uninstall both Teamprise Team Provider and Teamprise Standard Check-in Policy Plug-ins. To resolve this issue, restart Eclipse and uninstall both plugins. For more information, see Uninstall the Teamprise Plug-in.

Errors when Accessing the TFS Explorer Perspective

After you uninstall the Teamprise plug-in, the TFS Explorer perspective tab might still appear. If you access that perspective, errors appear. To dismiss the perspective, right-click in the perspective, and click Close. You should instead use the Team Foundation Server Exploring perspective.

Errors when Working with Projects that are Associated with the Teamprise Plug-in After It is Uninstalled

After you uninstall the Teamprise plug-in, if you still have projects or Eclipse workspaces that are still associated with that plug-in, you must perform the following steps:

  1. In Project Explorer or Package Explorer, right-click the project, and click Delete. In the Delete Resources dialog box, verify that the Delete project contents on disk check box is cleared, and then click OK.

  2. On the File menu, click Import.

  3. Expand the General node, and click Existing projects into Workspace.

  4. Specify the projects that you removed in step 1, and then click Finish.

  5. Complete the steps in the procedure titled To associate your local Eclipse workspace with the same Team Foundation Server workspace, in the Update Associations for Projects to use the Team Foundation Server Plug-in for Eclipse section of this topic.