Teamprise Knowledge Base

TKB00013 Adding the Teamprise Command Line Client to Your Path

Last updated 2006-04-04 22:03:35 UTC by Shaw Terwilliger

Overview

In order to run the Teamprise Command Line Client easily from the command line, you should add the directory containing the CLC executable to your shell's execution path. Because the command line shells are different for each platform, the instructions are platform specific.

Prerequisites

Make sure you have installed the Teamprise Command Line Client. For installation instructions, follow the link to the referenced article at the bottom of this page.

Configuration

Windows

Assuming the Teamprise Command Line Client has been installed into the directory C:\Program Files\Teamprise\CLC, that directory should be added to the execution path. If you chose a different directory when you installed the CLC, use the correct path in the steps below.

  1. Click the Start button
  2. Right-click on My Computer and choose Properties
  3. Click the Advanced tab, then click the Environment Variables button
  4. In the list at the top, select the line that starts with PATH, then click the Edit button in the top half of the window
  5. In the Variable value text box, add a semicolon and the correct path (C:\Program Files\Teamprise\CLC) to the end of the existing text
  6. Click OK in all the open windows to apply your changes

Now, when you open a command prompt window, typing "tf" should cause the Teamprise Command Line Client's help text to display. If you get the error message, 'tf' is not recognized as an internal or external command, verify the path you added in step 5 contains the tf.cmd file.

Unix (including Mac OS X)

The configuration procedure for Unix depends on which command shell you use. Most Unix operating systems default to the sh or bash shell. Assuming the Teamprise Command Line Client has been installed into the directory ~/teamprise-clc, that directory should be added to our execution path. If you chose a different directory when you installed the CLC, use the correct path in the steps below.

Note: If the CLC was installed inside your home directory and the "~" syntax is not parsed correctly by your shell, try substituting "$HOME" for "~" (example: "$HOME/teamprise-clc").

bash

This shell is the most commonly used shell on Linux, but it also common on other Unix platforms. Open the file ~/.bashrc in a text editor. If the file already contains a line starting with "PATH=", add a colon and ~/teamprise-clc to the end of this line (before any quotes if they exist). An example line, updated with the CLC path, would look like this:

PATH="/usr/local/bin:/usr/bin:/bin:/usr/bin/X11:/usr/games:~/teamprise-clc"

If your ~/.bashrc does not exist, or does not contain a line starting with "PATH=", add the following line to the end of the file. This form will preserve any existing path inherited by your shell (usually set by your system administrator).

PATH="$PATH:~/teamprise-clc"

Save and close the file.

All new bash shells for your Unix user will now include the Teamprise CLC executable in their execution paths. To update the current shell's path, you may simply type in the line above at the command prompt and press Enter.

csh / tcsh

Open the file ~/.cshrc (~/.tcshrc for tcsh) in a text editor. If the file already contains a line starting with "set path =", add a space and ~/teamprise-clc to that line before the closing parenthesis. An example line, updated with the CLC path, would look like this:

set path = ( /usr/local/bin /usr/bin /bin /usr/bin/X11 /usr/games ~/teamprise-clc )

If your ~/.cshrc (~/.tcshrc for tcsh) does not exist, or does not contain a line starting with "set path =", add the following line to the end of the file. This form will preserve any existing path inherited by your shell (usually set by your system administrator).

set path = ( $path ~/teamprise-clc )

Save and close the file.

All new csh (or tcsh) shells for your Unix user will now include the Teamprise CLC executable in their execution paths. To update the current shell's path, you may simply type in the line above at the command prompt and press Enter.

zsh

The procedure is similar to bash, but the file ~/.zshrc should be edited instead.

sh

This shell is commonly used on Solaris if bash is not available. The procedure is similar to bash, but the file ~/.profile should be edited instead.

ksh

This shell is commonly used on Solaris. The procedure is similar to bash, but the file ~/.profile should be edited instead.

Products affected:

  • Teamprise Command Line Client

Releases affected:

  • All

Platforms affected:

  • All

Related articles:

This article is referenced by these articles:

Keywords: path execution wrapper native script command setting