Rational ClearCase Remote Client Command Line Interface (CCRC CLI)

Downloadable files


Abstract

IBM® Rational® CCRC CLI is a tool that provides a command-line interface for ClearCase® Remote Client (CCRC) users to perform commonly used ClearCase® operations over a WAN

Download Description

The ClearCase Remote Client command-line interface provides the following commands, which can be used in both interactive and noninteractive modes:

  • login
  • logoff/logout
  • mkview
  • edcs
  • catcs
  • mkelem
  • checkout
  • uncheckout
  • reserve
  • unreserve
  • update
  • describe
  • checkin
  • lsview
  • lscheckout
  • lsvob
  • ls
  • cd
  • pwd
  • rmelem
  • rmname
  • rmview
  • mkstream
  • quit
  • help

This command-line interface supports scenarios in which the commands (except for the mkstream command) are used by developers working in base ClearCase.

UCM is not presently supported.

For detailed information about the commands, see the Rational ClearCase command reference.

Command Synopsis

catcs [-username user-name][-ser/ver server-url][-pas/sword user-password][-tag view-tag]

cd [-username user-name][-ser/ver server-url][-pas/sword user-password][dir-pname]

checkin | ci [-username user-name][-ser/ver server-url][-pas/sword user-password][-c/omment comment | -nc/omment] [-kee/p | -rm] [-fro/m source-pname][-ide/ntical] {-cac/t | activity_selector ... | pname ...}

checkout | co [-username user-name][-ser/ver server-url][-pas/sword user-password][-res/erved][-unr/eserved [-nma/ster]][-use/hijack][-c/omment comment | -nc/omment] pname ...

desc/ribe [-username user-name][-ser/ver server-url][-pas/sword user-password][-l/ong |-s/hort] [-ala/bel {label-type-selector[,...] | -all}][-aat/tr {attr-type-selector[,...] | -all}][-ahl/ink {hlink-type-selector[,...] | -all}]{ [-cvi/ew] [-pre/decessor] pname ...| -type type-selector ...| -cac/t | object_selector ...}

edcs [-username user-name][-ser/ver server-url][-pas/sword user-password][-ove/rwrite | -ren/ame][file]

logoff | logout

login [-username user-name][-ser/ver server-url][-pas/sword user-password]

ls [-username user-name][-ser/ver server-url][-pas/sword user-password]

lsc/heckout | lsco [-username user-name][-ser/ver server-url][-pas/sword user-password][-l/ong | -s/hort ][cvi/ew][-me | -use/r login-name][-r/ecurse | -d/irectory][pname...]

lsview [-username user-name][-ser/ver server-url][-pas/sword user-password][-s/hort | -l/ong][-pro/perties [-ful/l | -text_mode] | -age][-cview | view-tag-pattern ... | -cop/yarea copyarea-pname ...] [-uuid view-uuid]


lsvob [-username user-name][-ser/ver server-url][-pas/sword user-password][-s/hort | -l/ong] [-host hostname][vob-tag-name ...]

mkelem [-username user-name][-ser/ver server-url][-pas/sword user-password] [-eltype elem-type-name][-mkpath][-c/omment comment | -nc/omment] element-pname ...

mkstream [-username user-name][-ser/ver server-url][-pas/sword user-password] -integration -in project-selector [-target stream-selector][-c/omment comment | -nc/omment][stream-selector ...]

mkstream [-username user-name][-ser/ver server-url][-pas/sword user-password] -in {project-selector | stream-selector}[-c/omment comment | -nc/omment][-readonly] [stream-selector ...]

mkview [-username user-name][-ser/ver server-url][-pas/sword user-password][-tag web-view-tag][-tmo/de {insert_cr | transparent | strip_cr}[-str/eam stream-selector] web-view-pname

pwd [-username user-name][-ser/ver server-url][-pas/sword user-password]

res/erve [-username user-name][-ser/ver server-url][-pas/sword user-password] [-cac/t] pname...

rmelem [-username user-name][-ser/ver server-url][-pas/sword user-password][-f/orce] [-c/omment comment | -nc/omment] {pname ...}

rm/name [-username user-name][-ser/ver server-url][-pas/sword user-password][-c/omment comment | -nc/omment] {pname...}

rmview [-username user-name][-ser/ver server-url][-pas/sword user-password][-f/orce][-tag web-view-tag]{cop/yarea-view-pname}

uncheckout | unco [-username user-name][-ser/ver server-url][-pas/sword user-password][-kee/p] {-cac/t [pname ...] | pname ...}

unres/erve [-username user-name][-ser/ver server-url][-pas/sword user-password][-cac/t] pname...

update [-username user-name][-ser/ver server-url][-pas/sword user-password][-print] [-ove/rwrite | -nove/rwrite | -ren/ame][pname ...]

update -add/_loadrules [-print] [-ove/rwrite | -nove/rwrite | -ren/ame] pname [pname ...]

Prerequisites


1. Before installing the CCRC CLI, install one of the following applications on the client computer (Version based on compatibility table below):

  • CCRC stand-alone client

    OR
  • CCRC plug-in for Eclipse

To install ClearCase Remote Client V7.1.x, refer to Installing the Rational® ClearCase® Remote Clients.
To install ClearTeam Explorer V8.0, refer to Installing the Rational® ClearTeam Explorer®.

2 . Install Java Runtime Environment (JRE)
  • Version 1.5 (Java 5) for CCRC CLI V 7.1.x.
  • Version 1.6 (Java 6) for CCRC CLI V 8.0.

3. Refer to the following client-server matrix to have the correct version of CM Server.

The compatibility between CCRC CLI and the CM Server is based on the CM API or CCRC version used.
NOTE: Select the supported version of the CM API as per the table below. Select the version of CCRC CLI which matches the version of CCRC on the same machine.


CM API/CCRC version
CM API/CM Server version
CM API/ CCRC WAN Server version
7.1
7.1.0.1
7.1.0.2
7.1.1.y
7.1.2.y
8.0
8.0.0.1 8.0.0.2
7.1
Y
Y
N
N
N
N
N
N
7.1.0.1
N
Y
N
N
N
N
N
N
7.1.0.2
N
N
Y
N
N
N
N
N
7.1.1.x
N
N
N
Y (if x <= y)
N (if x > y)
Y
N
N
N
7.1.2.x
N
N
N
N
Y (if x <= y)
N (if x > y)
N
N
N
8.0
N
N
N
N
N
Y
Y
Y
8.0.0.1
N
N
N
N
N
Y
Y
Y
8.0.0.2
N
N
N
N
N
Y
Y
Y


4. System requirements for CCRC CLI are the same as that for CCRC Plug-in or CCRC RCP installation. For details, refer to the System Requirements for the ClearCase Remote Client

Note: Do not use IBM Installation Manager to roll back an installed version of CCRC to an earlier version. Instead, uninstall the installed version and then install the earlier version.

Installation Instructions

1. Download the CCRCCLI.zip file (based on platform selection) from this document.

2. Extract the content of this zip file into a directory, hereafter designated <ccrc_cli_home>.

Note: Do not specify the ClearCase or CCRC installation directories or their subdirectories as <ccrc_cli_home>.

3. The zip file includes:

    a. rcleartool.jar
    b. commons-cli-1.1.jar
    c. config.ini
    d. logging.properties
    e. rcleartool.bat (for Windows platform)
    f. rcleartool (for Linux/Solaris platform)
    g. licenses (folder)
    h. README

4. Optional: To run CCRC CLI from any directory (that is, not only from <ccrc_cli_home>) in a command or shell prompt, perform Steps 4a and 4b for a particular command or shell session.
    a. Set the environment variable ‘CCRCCLI’ to the value of <ccrc_cli_home>, as shown at the command or shell prompt. Do not enclose values in quotes.

    Windows:


      SET CCRCCLI=<ccrc_cli_home>

    Linux and Solaris:

      export CCRCCLI=<ccrc_cli_home>
      or
      the equivalent setenv.
    b. Append <ccrc_cli_home> to the ‘PATH’ environment variable values, as shown at the command/shell prompt:

    Windows:


      SET PATH=%PATH%;%CCRCCLI%

    Linux and Solaris:

      export PATH =$PATH:$CCRCCLI
      or
      the equivalent setenv.
Otherwise, go to step #5.


5. Open the config.ini file in a text-editor. This file contains two unset variables, CCSHARED & JAVA_HOME.

6. Edit the file as follows:
    a. Set the value of ‘CCSHARED’ to the path of the Shared Resource Directory. For the CCRC stand-alone client, perform Step 6a.i. For the CCRC plug-in for Eclipse, perform Step 6a.ii. Do not enclose values in quotes.

      i. For the CCRC standalone client, locate the Shared Resource Directory:

        1. Open IBM Installation Manager.
        2. Click Open File > View Installed Packages.
        3. Select the “IBM ClearCase Remote Client” and check the “Details” in the same window.
        4. The “Details” section provides the information under the label, Shared Resource Directory.

      ii. For the CCRC plug-in for Eclipse, locate the Shared Resource Directory:

        1. Open the Eclipse instance.
        2. Click Preferences > Plug-in Development > Target Platform
        3. Select the ‘Location’ information available on the ‘Target Platform’ window.
        4. Use this location information as Shared Resource Directory.
    b. Set the value of ‘JAVA_HOME’ to the ‘home directory of Java 5’ (for CCRC CLI versions 7.1.x) or ‘home directory of Java 6’ (for CCRC CLI versions 8.x). The ‘home directory of Java’ is the parent directory of ‘lib’ and ‘bin’ subdirectories of JRE.

    c. Save the file.
7. Open the command or shell prompt.

8. Navigate to <ccrc_cli_home>. (If you have completed step #4, this step is unnecessary.)

9. Type ‘rcleartool’.

10. You are asked to read the license agreements, available in <ccrc_cli_home>/licenses directory. Choose a license agreement.

11. Press <Enter> after you have read the terms of the agreement.

12. You are asked to accept the terms of the license agreement (if you accept the license terms, you will not be prompted to accept the license agreement again). Type ‘Y’, if you accept; otherwise, type ‘N’.
    a. If you type ‘Y’, you will see the rcleartool prompt; type ‘quit’ to exit rcleartool.
    b. If you type ‘N’, you will be exited from rcleartool.

13. You can use the interface either in interactive or noninteractive mode:
    a. Interactive mode: rcleartool
    b. Noninteractive mode: rcleartool <command> <options…>

Note: Steps #9 to #12 must be executed by the owner of <cccrc_cli_home> directory and are mandatory to complete installation.



Uninstalling CCRC CLI

To uninstall CCRC CLI, delete <ccrc_cli_home>.



Displaying usage messages

To display command usage:
    • Interactive mode: <command-name> -help
    • Noninteractive mode: rcleartool <command-name> -help


Logging Configuration

The logging configuration file, logging.properties, is located in <ccrc_cli_home>. CCRC CLI generates the log with default logging level set to INFO. Refer to entry ‘.level=INFO’, in the logging properties. The log file is written to your home directory (refer to platform-specific documentation for home directory information) and is named CCRC_CLI_ X.log. X. You can set .level to any of the following values:
    SEVERE (highest value)
    WARNING
    INFO (default value)
    CONFIG
    FINE
    FINER
    FINEST (lowest value)



Known Issues
  • On Linux systems, CCRC CLI may display the following warning:
    tzmappings: Illegal format near line 11
    This warning is caused by the presence of the JRE tzmappings file and is harmless. To suppress the warning:
    dos2unix <JAVA_HOME>/lib/tzmappings
  • Sometimes an operation such as loading or updating a view fails with one of the following errors:
    Error: java.io.IOException: chunked stream ended unexpectedly
    or
    Error: com.ibm.rational.clearcase.remote_core.rpc.MalformedResponseException: Part body: premature EOF
    This issue affects Solaris systems only. Such errors occur when the operation has only partially completed. When you retry the operation, it either runs to completion or proceeds further before another such error occurs. Repeat the operation as necessary until no error is displayed. Alternatively, for operations such as loading views, you can iteratively load small subsets of elements specified by the load rules.
  • CCRC CLI may not work on a Windows system on which a platform emulator such as Cygwin or MKS are installed. when running rcleartool.bat a user may receive the error:

    unable to access "com.ibm.rational.teamapi_": The system cannot find the file specified.

    The problem occurs due to the presence of the find command in both Windows and the platform emulator.

    To avoid this issue, ensure that the Windows system path specified by PATH precedes the platform emulator path as rcleartool needs to find the operating system find.exe first.

    This problem can also be avoided by making the following change to rcleartool.bat entry:
    (line may wrap)

    for /f "delims=/ tokens=1,*" %%i in ('dir /AD/OD/b "%CCSHARED%\plugins"^|find "com.ibm.rational.teamapi_"') do Set CMAPIFOLDER=%%i

    replace with

    for /f "delims=/ tokens=1,*" %%i in ('dir /AD/OD/b "%CCSHARED%\plugins"^|%SYSTEMROOT%\system32\find.exe "com.ibm.rational.teamapi_"') do Set CMAPIFOLDER=%%i

    If your system does not have the default operating system find on %SYSTEMROOT%\system32 (typically C:\Windows\System32), then change that location to what may be appropriate on your system.
  • Checkout command with option reserve (co -reserve) performs checkout as unreserved when version-controlled element is already checked out reserved.

Download package

By downloading, installing, copying, accessing or using this feature, you agree to the terms of the license agreement provided below. If you do not agree to these terms, do not download, install, copy, access, or use this feature.

Note: Use All Unix download to setup CCRC CLI on Unix and Linux platforms.

Download RELEASE DATE LANGUAGE SIZE(Bytes) Download Options
7.1.0.1 Windows 5 Feb 2009 English 365568 FTP
7.1.0.1 All Unix 5 Feb 2009 English 365568 FTP
7.1.1.6 & 7.1.2.3 Windows 1 Nov 2011 English 367616 FTP
7.1.1.6 & 7.1.2.3 All Unix 1 Nov 2011 English 367616 FTP
8.0 All Platforms 1 Dec 2011 English 482962 FTP
8.0.0.1 All Platforms 29 Dec 2011 English 482960 FTP
7.1.1.8 & 7.1.2.5 All Platforms 29 Dec 2011 English 364013 FTP
7.1.1.9 & 7.1.2.6 All Platforms 30 Apr 2012 English 362230 FTP
8.0.0.2 All Platforms 30 Apr 2012 English 482959 FTP

Product Alias/Synonym

CCRCCLI

Rate this page:

(0 users)Average rating

Document information


More support for:

Rational ClearCase
ClearCase Remote Client

Software version:

7.1, 7.1.0.1, 7.1.0.2, 7.1.1, 7.1.1.1, 7.1.1.2, 7.1.1.3, 7.1.1.8, 7.1.1.9, 7.1.2, 7.1.2.1, 7.1.2.2, 7.1.2.3, 7.1.2.4, 7.1.2.5, 7.1.2.6, 8.0, 8.0.0.1, 8.0.0.2

Operating system(s):

AIX, HP-UX, Linux, Solaris, Windows

Reference #:

4021929

Modified date:

2012-04-30

Translate my page

Machine Translation

Content navigation