2 Connecting

HitKeeper must be installed and running. To use this tutorial interactively (in the HTML version), Web services must be active.

If you have a local installation of HitKeeper, you can connect to the ’hkdemo’ database using (fix the paths!)


/home/hitkeeper/bin/HKReader -c /home/hitkeeper/hkdemo.conf

If you are using a remote installation, you can download a command-line client from the HitKeeper home page, save it as HKRemote and make it executable. By default, when launched



will connect to the REST-based Web service of the remote HitKeeper server from which it was downloaded. The behaviour of this client is identical to the one of the local client; but the default values for the timeout and maximal number of rows might be set differently (see the documentation for details).

If you are using this tutorial via a Web browser, most examples can be executed by clicking on them. These will invoke the REST-based Web service, or the interactive HTML server. It is recommended to keep track of the exercise in a simple text editor.

The SOAP-base Web service is not addressed directly by this tutorial. Its logic and behaviour, and the name of the different operations and argument are strictly identical to the ones used in the other interfaces. Refer to the wsdl file for all the details.