Bamboo Command Line Interface

Name	Bamboo Command Line Interface (CLI)
Version	1.0.0
State	beta
Product Versions	Bamboo 1.1.x, 2.0.x
Dependencies	Java 1.5 on client
Author(s)	Bob Swift
Issue Tracking	http://developer.atlassian.com/jira/browse/BCLI
Price	free!
License	BSD license
Source	http://svn.atlassian.com/svn/public/contrib/bamboo/bamboo-cli
Download	bamboo-cli-1.0.0-distribution.zip

.

Download statistics for 1.x.x

Date	2008-Aug
Hits	0

Introduction

This is a command line interface for remotely accessing Bamboo using Bamboo's REST APIs. This is a working command line client that can be used directly with your installation. It also serves as an example of using Java to access Bamboo's REST API to implement Bamboo automation. The client can run on any platform with Java 1.5. The Bamboo remote APIs are currently fairly limited, but likely to improve over time.

Additional information

Atlassian Command Line Interface - includes Bamboo CLI

Related CLI clients

All CLI clients have a standarized interface and implementation.

Installation

Unzip the distribution package and put the enclosed directory in a convenient location
Ensure Remote API is enabled in your installation
- You need to be an administrator
- Accept remote API calls? should be checked in the Administration - General Configuration section

Usage

On a command line, cd to the directory where you installed the client
On Windows
- Run bamboo
On Linux (or Windows)
- Run java -jar release/bamboo-cli-1.0.0.jar
This will show help text for the command line interface client
The client defaults to use a user of automation. Either add this user with all the authorities required to do the actions you want or specify a different user parameter
It is recommended that you open the bamboo.bat file with an editor and customize it for your environment by adding server, user, and password parameters. Follow the example in the comments and make sure you do not remove the %* at the end of the line.

Examples

Note: the following examples assume that the bamboo.bat file has been customized for your environment as noted above.

From a command line, change directory (cd) to the directory where the zip was unpacked

bamboo --action listBuilds

bamboo --action listProjects

bamboo --action getProject --project EXP

bamboo --action getLatestBuildResults --build EXP-ONE

bamboo --action getLatestBuildResults --project EXP

bamboo --action executeBuild --build EXP-ONE

bamboo --help

Help text

The following help text is displayed with --help option

Usage:
  bamboo [--help] (-a|--action) <action> [--debug] [-v|--verbose] (-s|--server)
  <server> (-u|--user) <user> (-p|--password) <password> [--login <login>]
  [--service <service>] [-l|--loginFromStandardInput] [(-f|--file) <file>]
  [--build <build>] [--project <project>]


        Provides capability to make requests to a remote server.
        Required parameters: action, server, password.
        Optional parameters: user (likely required for your installation).
        Other required and optional parameters depending on action requested.


  [--help]
        Prints this help message.

  (-a|--action) <action>
        Requested operation to perform. Valid actions (not case sensitive) are:

        login - Login to remote server. Returns login token.
                 Required parameters: password
                 Optional parameters: user
        logout - Logout of remote server.
        listProjects - List project names.
                 Optional parameters: file
        getProject - Get project details.
                 Required parameters: project
                 Optional parameters: file
        listBuilds - List build names.
                 Optional parameters: file
        getLatestBuildResults - Get build results for a build or project.
                 Required parameters: build or project
                 Optional parameters: file
        executeBuild - Run a build by key.
                 Required parameters: build

  [--debug]
        Requests debug output, example: stack traces.

  [-v|--verbose]
        Requests verbose output.

  (-s|--server) <server>
        Server URL.

  (-u|--user) <user>
        User name for remote login. (default: automation)

  (-p|--password) <password>
        User password for remote login.

  [--login <login>]
        Login token from previous login request.

  [--service <service>]
        Service address extension. (default: /api/rest/)

  [-l|--loginFromStandardInput]
        Get login token from standard input.

  [(-f|--file) <file>]
        Path to file for output

  [--build <build>]
        Build key.

  [--project <project>]
        Project key.

License

The software provided for this tool has a BSD style license
The distribution ships binaries with an LGPL licence
Look in the license directory for detailed license information

Version history

Date	Version	Notes
May 8, 2008	1.0.0	Updated to new CLI common functions and work with 2.0
June 10, 2007	0.1	Beta - initial release

Open Issues

Atlassian Developer Network JIRA (1 issues)

T

Key

Summary

Reporter

Assignee

Pr

Status

BCLI-1

Support new APIs available in Bamboo 2.0

Bob Swift

In Progress