You can use the IBM Installation Manager to
install the VersionVault Remote Client command-line
interface (CLI) that is part of VersionVault
Explorer
package.
Before you begin
The VersionVault Remote Client CLI is
installed with the VersionVault
Explorer package. The package is available for install through the
Installation Manager.
Note: HCL
VersionVault
provides two clients for software developers: local and remote. Each client supports
different mechanisms for accessing source-controlled filesystem objects. Both clients
provide graphical and command-line interfaces.
The following table summarizes some
important characteristics of the two clients.
Table 1. Characteristics of VersionVault clients for software
developers
Client |
Network connection type |
Connection to repository of source-controlled
objects |
View types |
User interfaces |
VersionVault Local Client |
LAN only |
RPC connection to a Versioned Object Base (VOB) |
|
- GUI: VersionVault
Explorer
- CLI: cleartool
|
VersionVault Remote
Client |
WAN and LAN |
http(s) connection to a VOB through a VersionVault WAN server |
|
- GUI: VersionVault
Explorer
- CLI: rcleartool
|
The term view, as used in this table, refers to the
mechanism for accessing versions in a VOB. For example, snapshot, automatic and web
views provide copy-based mechanisms, whereas the dynamic view provides a mechanism to
directly access versions in real time.
Another use of the term
view
refers to the configuration management model that governs the development of software.
The two models are called Base
VersionVault and Unified Change Management (UCM):
- In a Base VersionVault view, you
specify the configuration explicitly by rules for version selection, branching, and
so on.
- In a UCM view, the configuration is generated by VersionVault operations such as creating a
development stream.
For more information, see the "Developing software with
HCL
VersionVault
Explorer" topic.
HCL
VersionVault or HCL
VersionVault Remote Client
Installing either
HCL
VersionVault or
HCL
VersionVault Remote Client, installs
VersionVault Remote Client CLI. These are
sample paths to the installation:
- Windows:
C:\Program Files\HCL\CCM\VersionVault\RemoteClient\rcleartool.bat
C:\Program Files\HCL\CCM\VersionVault\RemoteClient\rcleartool.conf
- UNIX/Linux:
/opt/hcl/ccm/versionvault/RemoteClient/rcleartool
-
/opt/hcl/ccm/versionvault/RemoteClient/rcleartool.conf
Procedure
If you are installing VersionVault
Explorer from the
Eclipse update site, 'rcleartool.bat' / 'rcleartool' scripts must be configured manually. Take the
following steps to manually configure the rcleartool scripts.
In the following example, <ECLIPSE_HOME>
refers to the location of your eclipse installation, the same directory
eclipse.exe would reside.
-
On Windows:
The rcleartool
script is included in the com.hcl.ccm.ccrc.cli plugin that is
added to your eclipse installation when you install VersionVault
Explorer from the VersionVault
Explorer update site. You need to look for a
directory that starts with com.hcl.ccm.ccrc.cli in the following
locations, and then use the one with the latest version number.
- <ECLIPSE_HOME>\plugins
- %USERPROFILE%\.p2\pool\plugins
In the examples that follow, <CCRC_CLI_PLUGIN_DIR> refers to the location of the
latest com.hcl.ccm.ccrc.cli plugin.
-
For rcleartool.bat: Copy 'rcleartool.bat' from
<CCRC_CLI_PLUGIN_DIR>\scripts\rcleartool.bat to
<ECLIPSE_HOME>\rcleartool.bat
For rcleartool.conf: Copy 'rcleartool.conf' from
<CCRC_CLI_PLUGIN_DIR>\scripts\rcleartool.conf to
<ECLIPSE_HOME>\rcleartool.conf
-
Open 'rcleartool.bat' to edit the following line replacing <JAVA_EXE_PATH> with
the full path to your installed version of Java 11 (or greater) JRE:
from:
if not defined_JAVACMD set _JAVACMD=_JAVA_CMD_PATH
to:
if not defined_JAVACMD set _JAVACMD=<JAVA_EXE_PATH>
This is an example of a valid input for this
line:
if not defined _JAVACMD set _JAVACMD=C:\Program Files\Eclipse Adoptium\jre-11.0.18.10-hotspot\bin\java.exe
-
Run 'rcleartool setup' once to configure the remaining paths automatically.
-
You can now add <ECLIPSE_HOME> to your system PATH variable to run rcleartool
from any directory in your command window.
-
UNIX/Linux:
The rcleartool
script is included in the com.hcl.ccm.ccrc.cli plugin that is
added to your eclipse installation if you install Eclipse with the Eclipse installer.
You need to look for a directory that starts with com.hcl.ccm.ccrc.cli in the following
locations, and then use the one with the latest version number.
- <ECLIPSE_HOME>/plugins
- ~/.p2/pool/plugins
In the examples that follow, <CCRC_CLI_PLUGIN_DIR> refers to the location of the
latest com.hcl.ccm.ccrc.cli plugin.
-
For rcleartool: Copy 'rcleartool' from
<CCRC_CLI_PLUGIN_DIR>/scripts/rcleartool to
<ECLIPSE_HOME>/rcleartool
For rcleartool.conf: Copy 'rcleartool.conf' from
<CCRC_CLI_PLUGIN_DIR>/scripts/rcleartool.conf to
<ECLIPSE_HOME>/rcleartool.conf
-
Open 'rcleartool' to edit the following line replacing <JAVA_EXE_PATH> with the
full path to your installed version of Java 11, or greater, JRE:
from:
_JAVACMD=${_JAVACMD:-_JAVA_CMD_PATH_}
to:
_JAVACMD=${_JAVACMD:-<JAVA_EXE_PATH>}
This is an example of a valid input for this line:
_JAVACMD=${_JAVACMD:-/usr/lib/jvm/jre-11/bin/java}
-
Add execute permission to rcleartool:
chmod +x <ECLIPSE_HOME>/rcleartool
-
Run 'rcleartool setup' once to configure the remaining paths automatically.
-
You can now add <ECLIPSE_HOME> to your system PATH variable.