Added by Bob Swift, last edited by Bob Swift on Oct 18, 2009  (view change) show comment

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.
Name Atlassian Command Line Interface
Version 1.3.0
Product Versions Confluence: 2.x - 3.0
JIRA: 3.13 - 4.0
Crowd: 2.0
Bamboo: 2.0 - 2.4
FishEye: 1.6 - 2.0
Crucible: 1.6 - 2.0
Author(s) Bob Swift
Homepage  
Price free
License BSD
JavaDocs  
IssueTracking Atassian CLI
Confluence CLI
JIRA CLI
Bamboo CLI
FishEye/Crucible CLI
Download 1.3.0
Download Source SVN - see project specific CLI page
1.3.0 all source distribution

Plugin exchange

Related CLI clients

Atlassian CLI clients have standard interfaces and implementation. See Atlassian Command Line Interface for related information.

Atlassian CLI distribution
If you have more than one Atlassian product, use the Atlassian Command Line Interface distribution. It is now current with all the latest product specific distributions.

Description

This is a command line interface (CLI) for remotely accessing Atlassian products. This provides a convenient way to automate administration tasks and content for Atlassian products. Examples are build and test automation or other business processes. This is a working command line client that can be used directly with your installation. This distribution makes it convenient to have a single installation to access all your Atlassian products. For each product, it is functionally equivalent to the individual product (at the same release level) as it is derived from the built individual CLI product.

All CLI tools have standard interfaces and implementations. They share common components that can be used to build additional CLI-like tools.

Entry details

The Atlassian CLI debuted in Codegeist 2008. It has been significantly enhanced since then and now covers all Atlassian (server) products. The following describes the enhancements made to the Atlassian Command Line Interface since Codegiest 2008.

Atlassian CLI
  • 3 releases - 1.1.0, 1.2.0, 1.3.0
  • Automated build from independent distributions
  • Automated function test infrastructure
  • Standardization and consistency, common code, refactoring
    • User management code refactored into a common component (used by Confluence and JIRA CLI)
    • Common code for plugin support including listing and linking with Plugin Exchange (used by Confluence and JIRA CLI)
    • Command scripts for Windows (bat), Linux (sh), and Mac (sh)
  • Automate and standardize help and example output in distribution (see example directory)
  • Standardize documentation pages
JIRA CLI
  • 5 releases - 1.1.0, 1.2.1, 1.3.0, 1.4.0, 1.5.0
  • support both SOAP and REST based APIs
  • support issue and subtask creation including custom fields
  • workflow actions (progress issue)
  • project support with versions and components including auto creation
  • user management
  • plugin actions
  • JIRA 4.0 support
Confluence CLI
  • 2 releases - 1.4.0, 1.5.0
  • support both SOAP and REST based APIs
  • support copy actions (labels, comments, attachments, spaces)
  • support copy actions to secondary target server
  • comment actions
  • plugin actions
  • Confluence 3.0 support
Crowd CLI
  • Initial release - 1.0.0
  • get user, group, directory
  • Crowd 2.0 support
Bamboo CLI
  • 1 release - 1.1.0
  • standardization
  • Bamboo 2.4 support
FishEye CLI
  • 1 release - 1.1.0
  • standardization
  • FishEye 2.0 support
Crucible CLI
  • 1 release - 1.1.0
  • standardization
  • Crucible 2.0 support

Coverage

Product Product CLI page Type CLI coverage
of available APIs 		Remote API coverage
of product capability
Confluence Confluence Command Line Interface SOAP
REST 		good good
JIRA JIRA Command Line Interface SOAP
REST 		good good
Bamboo Bamboo Command Line Interface REST good limited
Fisheye FishEye Command Line Interface REST good limited
Crucible Crucible Command Line Interface REST limited minimal
Crowd Crowd Command Line Interface REST limited minimal

Installation

  • Unzip the distribution package and put the enclosed directory in a convenient location
  • Ensure the Remote API capability is enabled for any product you wish to access with the client.

Usage

  • On a command line, cd to the directory where you installed the client
  • On Windows
    • Run the product specific (confluence, jira, bamboo, fisheye, crucible, crowd) bat file
  • On Linux, Mac, or Unix
    • Run the product specific .sh file
  • On any system supporting JAVA
    • Run java -jar release/<product>-cli-1.x.x.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 each product 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

Each CLI client has documented examples:

Help text

Each CLI client has documented help text:

Each client comes with standard help text displayed by the default command or using --help. This gives the precise definition of parameters. The product specific CLI pages have a copy of the online help. All follow standards and all have consistent parameters for cross product functions like action, server, user, password, file, ...

Tips
  • Use single dash for single letter parameters - example: -v
  • Use double dash for multi-letter parameter - example: --help
  • When parameters are specified, most need a value - example: --action addPage
  • Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
  • Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
  • Some parameters become required once a specific action is chosen. This is indicated in the help text for each value.
  • Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same
  • Some parameters have default values, if so, they are indicated below - example: (default: automation)
  • Some parameters are required - indicated by (...) - example: (-a|--action) <action>
  • Some parameters are optional - indicated by [...] - example: [(-f|--file) <file>]
  • Values that have more than one word must be enclosed by double quotes - example: --title "this is my title"

Error handling

Care is taken to return the appropriate exit codes to the command processor. This makes it possible do error handling in automation scripts. Error and error logging output is directed to standard error.

Error type Exit code Description
SUCCESS 0 Normal exit
CLIENT_EXCEPTION -1 The client has found a problem with the request and is reporting an error with a message.
PARAMETER_PROBLEM -2 The client processed the command parameters and found a syntax error or missing required parameters according to the parameter definition
REMOTE_EXCEPTION -3 The remote system has reported an error. The error message comes from the server.
FAILURE -99 The client program failed in an unexpected way.;

License

  • The software provided for this tool has a BSD style license
  • The distribution ships binaries with various licenses (BSD, LGPL, and Apache)
  • Look in the license directory for detailed license information

Release history

Version Date State License Price
No description provided 1.3.0 (#4) 17 Oct 2009 Stable Freeware / Open Source (BSD) Free
No description provided 1.2.0 (#3) 27 Sep 2009 Stable Freeware / Open Source (BSD) Free
Show description 1.1.0 (#2) 04 Sep 2009 Stable Freeware / Open Source (BSD) Free

Release Notes

This distribution contains the following clients

- Confluence 1.4.0
- JIRA 1.3.0
- Bamboo 1.1.0
- Crucible 1.1.0
- Fisheye 1.1.0
Show description 1.0.0 (#1) 18 Aug 2009 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Confluence CLI 1.2.0

JIRA CLI 1.0.0

Bamboo CLI 1.0.0

FishEye/Crucible CLI 1.0.0

Screenshots