All Versions
Fisheye 4.2 DocumentationFisheye 4.1 Documentation
Fisheye 4.0 Documentation
More...
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 |
|
JavaDocs |
|
IssueTracking |
http://developer.atlassian.com/jira/browse/FCLI |
Download ZIP |
|
Download Source |
http://svn.atlassian.com/svn/public/contrib/crucible/crucible-cli |
JVM requirements |
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.
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 Crucible CLI uses Crucible's REST API.
All CLI clients have a standard interface and implementation.
crucible --action listReviews crucible --action listReviews --state "review,summarize" crucible --action getReview --review CR-1 crucible --action getReview --review CR-1 --attribute comments
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
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, ...)
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."
Date |
Release |
Notes |
---|---|---|
May 8, 2008 |
1.0.0 |
Initial release |