FishEye 2.1 : Crucible Command Line Interface
This page last changed on Sep 11, 2009 by jnolen.
Description/FeaturesThis 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
Related CLI clientsAll CLI clients have a standard interface and implementation.
Installation
Usage
Examples
Help textThis 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.
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 handlingCare 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
Version History
|
![]() |
Document generated by Confluence on Nov 11, 2009 21:21 |