Teamprise Knowledge Base

TKB00039 Using the Command Line Client

Last updated 2006-10-24 18:11:53 UTC by Shaw Terwilliger

Introduction

The Teamprise Command Line Client (sometimes called CLC) is a text console-based Team Foundation source control client designed to be run from the command line. The argument syntax is very similar to Microsoft's "tf.exe" command line client that comes with Microsoft Team Foundation Client for Visual Studio 2005, but a few differences remain.

Similarities

The Teamprise CLC uses the same workflow patterns as Microsoft's command line client. First a Team Foundation Server workspace is created for the client computer, then a working folder mapping is added to this workspace that links a directory on the local computer to a Team Foundation Server source control path. Then operations can be performed on files inside local directory that was mapped.

Walkthrough

For a detailed walkthrough of source control concepts via command line, see Microsoft's Walkthrough: Working with Team Foundation Source Control from Command Line.

Command Help and Reference

When invoked without arguments, or when invoked with the help command or /help option, the Teamprise CLC prints syntax information to the console. Explore this help facility to find all options allowed for each command.

The available commands are implemented similarly to Microsoft's client, a reference for which can be found here.

Differences

In order to support the conventions of the different platforms the Teamprise CLC supports, some changes to argument syntax and program behavior have been made. These differences are described below.

Installation

Installation is simple: download the appropriate archive, extract to your preferred destination, and run. See the KB article Installing Teamprise Command Line Client for installation and licensing steps. After you install the client, make sure it add it to your path.

Absolute Paths on Unix

For Teamprise 1.0 and 1.1 only, any absolute paths given to the Teamprise CLC on Unix platforms require two leading slashes. See this KB article for details. Teamprise 2.0 does not require this change to the arguments (instead, the only valid option prefix on Unix is the hyphen character and absolute paths are recognized without additional work).

Products affected:

  • Teamprise Command Line Client

Releases affected:

  • All

Platforms affected:

  • All

Related articles:

Keywords: user guide help command line client CLC reference commands options howto walkthrough