Getting Started

This page describes how to get the CLI tool started on your local machine.

Compiling dependent modules

The CLI module depends on three other toolforge modules : toolforge-core, karma-core and karma-launcher. These modules have to be compiled and deployed to your local Maven repository. The easiest route is to execute the following steps:

  • Check out the full toolforge project from Sourceforge.
  • On toolforge-core execute the jar:install goal. This will install toolforge-core-1.0-dev.jar into the local Maven repository (well, that is assuming you have that as your default repository.
  • On karma-launcher execute the jar goal. This will compile and package karma-launcher-1.2.jar into the target directory of the karma-launcher module. Copy this jar-file to karma-cli/lib.
  • Refer to the documentation site for the karma-core and follow the steps for the JUnit test setup. There is a manual procedure to follow before the karma-core module can be succesfully deployed as a jar in the Maven repository (honestly, that piece of documentation is missing : unpack karma-core/resources/test-CVSROOT.tgz in a directory of your choice and configure that directory in karma-core/resources/test-cvs.properties. Then : execute the jar:install goal on karma-core.
  • Last, but not least, the karma-cli module should be compiled. Use java:compile on the karma-cli module to compile the sources into the target/classes directory.

Configuration

$HOME/.karma should be created and a karma-launcher.properties with the property karma.repository.local created. This property should point to the maven repository directory on your system.

Karma (whichever user interface you use) depends on a few configuration items that must be present. Follow the following steps to configure your local environment.

  • A configuration directory $HOME/.karma should be created. The LocalEnvironment class will create this one upon instantiation, with the default configuration, if you don't supply one.
  • Create a karma.properties-file in that directory and configure the following properties:
    NameValue
    development.store/home/asmedes/karma/projects (default value)
    manifest.store/home/asmedes/karma/manifests (default value)
    location.store/home/asmedes/karma/locations (default value)
    manifest-store.cvs.hostCheck with your administrator.
    manifest-store.cvs.portCheck with your administrator.
    manifest-store.cvs.repositoryCheck with your administrator.

Start the Command Line Interface

All set ? Start the command line interface. Use bin/karma on a Unix system to see the thing happening (Windows users wait a bit or do it yourself for now). Maybe you'll have to include ant-1.6.1.jar and ant-launcher-1.6.1.jar into your maven repository.