Name Crucible Command Line Interface Version 1.0.0 Product Versions 1.5.x - tested 1.5.1 Author(s) Bob Swift Homepage   Price free License BSD JavaDocs   IssueTracking http://developer.atlassian.com/jira/browse/FCLI Download ZIP crucible-cli-1.0.0-distribution.zip Download Source http://svn.atlassian.com/svn/public/contrib/crucible/crucible-cli JVM requirements for client Java 1.5 and above Not yet available Crucible REST interfaces are new for 1.5 and the documentation is not complete. Waiting for Atlassian to provide necessary information to complete this tool.

Download statistics Date 2008-Dec Hits 0

Description/Features

This is a command line interface (CLI) for remotely accessing Crucible information . This is a working command line client that can be used directly with your installation. It provides a consistent interface with other Atlassian product CLI tools. The Crucibel CLI uses Crucible's REST API.

Additional information

• Crucible CLI - Remote API support matrix — List remote API functions supported by the Crucible CLI

• Atlassian Command Line Interface - includes the Crucible CLI

Related CLI clients

All CLI clients have a standard interface and implementation.

• Confluence Command Line Interface
• Bamboo Command Line Interface
• JIRA Command Line Interface
• FishEye Command Line Interface

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
  • Go to Admin menu -> General Administration -> Server Settings -> Remote API
  • Setting should be ON

Usage

• On a command line, cd to the directory where you installed the client
• On Windows
  • Run crucible
• On Linux (or Windows)
  • Run java -jar release/crucible-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 crucible.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 crucible.bat file has been customized for your environment as noted above.

  crucible --action listReviews
  
  crucible --action listReviews --state "review,summarize"
  
  crucible --action getReview --review CR-1
  
  crucible --action getReview --review CR-1 --attribute comments
  
  

Help text

This is the help text displayed by the default command or using --help. This gives the precise definition of parameters, however, it might be easier to just look at the examples. Note, the information in this section is automatically generated, so if you have edit suggestions, add a comment. Otherwise, your edits will be replaced on the next update.

Tips Use single dash for single letter parameters - example: -v Use double dash for multi-letter parameters - example: --help When parameters are specified, most need a value - example: --action listReviews 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: --PATH is invalid but --action listreviews is equivalent to --action listReviews 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: --query "select ..."

Usage:

Usage:
  crucible [--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>]
  [--review <review>] [--state <state>] [--attribute <attribute>]


	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.
        listReviews - List all reviews.
        	 Optional parameters: state, file
        getReview - Get review details.
        	 Required parameters: review
        	 Optional parameters: attribute, file

  [--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: /rest-service/)

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

  [(-f|--file) <file>]
        File for output.

  [--review <review>]
        Crucible review.

  [--state <state>]
        Review state.

  [--attribute <attribute>]
        Review attribute (comment, reviewitems, ...)

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.

License

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

Version History