Command Line Remote Run Tool

Skip to end of metadata
Go to start of metadata
This section concerns only the latest version of the plugin. You are welcome to download it directly from public TeamCity server.

General Info

Vendor JetBrains
License Apache 2.0
Type free, open-source

Plugin Description

TeamCity Command Line Remote Run tool allows running Personal Builds from the command line (Windows, Linux, Mac are supported, provided there is a JRE installed).

The tool has no integration with a version control. It's function is to start a personal build for the supplied list of files.
Server supports running personal builds for the sources stored under Subversion, CVS, Perforce and Git. Experimental support for ClearCase is also available.

The preferred way to start personal builds is to use IDE plugins, which integrate with version control and also provide ability to do pre-tested commits after successful personal build.

Since TeamCity 6.5 for Git and Mercurial you should really consider using remote run on branches, rather than this tool. If you still prefer the tool over remote run on branches, please make sure to drop us a line on that.

Plugin Development Status

In final stage of development.

TeamCity Versions Compatibility

The current plugin version is designed to work with TeamCity 7.0.x. Branch version is also available for 6.5.x, 6.0.x, 5.1.x and 5.0.x verisons.

Download

Directly from public TeamCity server:

8.0.x-compatible version
7.1.x-compatible version
7.0.x-compatible version
6.5.6-compatible version
6.5.0-6.5.5 -compatible version
6.0.x-compatible version
5.1.x-compatible version
5.0.x-compatible version

Documentation

Installation instructions

  1. Put command.line.zip into <TeamCity Data Directory>/plugins folder.
  2. Restart the server.

Plugin usage

To use the tool, Java JRE 1.5.+ should be installed on your working machine.

Download the tcc.jar from the "My Settings & Tools" > "TeamCity Tools" side panel > "Command Line Remote Run" to any directory.

The tool is run with the 'java -jar tcc.jar <command> <options>' command.

List of available commands is available upon 'java -jar tcc.jar help'. To get command description run 'java -jar tcc.jar help <command>'

To run personal builds the tool requires:

  1. .teamcity-mappings.properties configuration file which maps local paths in your project workspace to VCS settings in TeamCity. For details refer to the Сonfiguring plugin via UI options section below.
  2. TeamCity server URL and user credentials to authorize on the server. Use login command to authorize on the server before running the build. In this case you will need to specify the server URL only for the 'run' command. The "login" command persists credentials for target host to avoid authorization options for subsequent starts. Last logged in <server URL> is treated as default and will be used if "--host" key is omitted.
  3. buildTypeID of the target build configuration on the server. The buildTypeID is displayed in the drop-down list of available build configurations on the configuration web UI page of the Command Line Remote Run tool.
  4. Comment to the personal build
  5. Path to the changed files to be included in a personal build. You can provide path either to the directory with modified files or to a file with list of changed files (such file can be prepared with help of VCS own tools).Run remote build for the specified list of files with selected build configuration:

    By default the "run" command will wait for the build to finish and returns code corresponding to the status of the build. This exit code can be used to perform a commit.

Сonfiguring plugin via UI options

The plugin provides web UI configuration page which helps to create .teamcity-mapping.properties file.

  1. To open tool's settings page, navigate to "My settings & Tools" page, then click "configure" for the Command Line Remote Run in the "TeamCity Tools" side-panel.
  2. In the drop-down list select build configuration you want to run your personal build with and click "Add"
  3. Check the mappings table and edit if needed.
  4. When done, copy the resulting content of the configuration file to your .teamcity-mappings.properties file.

Put the configuration file in any the following directories:

  • root directory of the project sources to be sent to remote run (recommended)
  • %HOME%/.TeamCity-CommandLine default directory

Feedback/Support

If you believe you've faced a bug: Issue Tracker (project: TeamCity)
If you want to ask a question or discuss: Forum

Development links

Sources in JetBrains Subversion repository.
Trunk builds at JetBrains public TeamCity instance.

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.