Related information for 6.2.0

Help Text

 

Usage:
  all (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat
  <outputFormat>] [--columns <columns>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>]
  [--host <host>] [--port <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--dbJar <dbJar>]
  [--afterSql <afterSql>] [--dbTable <dbTable>] [--dbTableKeys <dbTableKeys>] [--dbCreateTable] [--comment <comment>] [--replace]
  [--propertyFile <propertyFile>] [--common <common>] [--special <special>] [--dateFormat <dateFormat>] [--dateFormat2 <dateFormat2>]
  [--reference <reference>] [--findReplace <findReplace>] [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--list2 <list2>]
  [--options <options>] [--continue] [--simulate] [--append] [--clearFileBeforeAppend] [--parameters <parameters>] [--jiraServer
  <jiraServer>] [--confluenceServer <confluenceServer>] [--bambooServer <bambooServer>] [--bitbucketServer <bitbucketServer>]
  [--hipchatServer <hipchatServer>] [--crucibleServer <crucibleServer>] [--fisheyeServer <fisheyeServer>] [--servicedeskServer
  <servicedeskServer>] [--upmServer <upmServer>] [(-u|--user) <user>] [(-p|--password) <password>] [--help]

	Provides capability to make requests.
	Required parameters: action, ...
	Optional parameters: ...
	Other required and optional parameters depending on action requested.


  (-a|--action) <action>
        Requested operation to perform. Valid actions are listed at the end.

  [(-f|--file) <file>]
        Path to file based content or result output. Use - for standard input.

  [--encoding <encoding>]
        Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

  [--debug]
        Requests detail debug output. Optional for all actions.

  [-v|--verbose]
        Requests verbose output to help with problem determination. Optional for all actions.

  [--quiet]
        Limit some output messages. Optional for all actions.

  [--outputFormat <outputFormat>]
        Specify output format for an action. (default: 1)

  [--columns <columns>]
        Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column
        names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns
        will be ignored.

  [--connectionTimeout <connectionTimeout>]
        Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

  [--sql <sql>]
        SQL select statement used to generate a run script.

  [--driver <driver>]
        JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

  [--url <url>]
        Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

  [--host <host>]
        Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.

  [--port <port>]
        Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

  [--database <database>]
        Database name is required for SQL actions.

  [--dbUser <dbUser>]
        Database user name. Defaults to user.

  [--dbPassword <dbPassword>]
        Database user password. Defaults to password.

  [--dbJar <dbJar>]
        By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url
        reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or
        https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar

  [--afterSql <afterSql>]
        SQL to run after a successful action. Limited to specific actions at this time.

  [--dbTable <dbTable>]
        Database table name when creating or updating a database from list output.

  [--dbTableKeys <dbTableKeys>]
        Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for
        the table.

  [--dbCreateTable]
        Database table needs to be created before adding rows.

  [--comment <comment>]
        Comment text.

  [--replace]
        Replace existing entity on add, create, or similar actions.

  [--propertyFile <propertyFile>]
        Property file with database parameters, field mappings, or client specific information.

  [--common <common>]
        Common parameter string added to all run actions.

  [--special <special>]
        Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters
        used for specialized processing of some specific parameters.

  [--dateFormat <dateFormat>]
        Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is
        lenient starting with client date format and then some other standard formats based on JSON date format.

  [--dateFormat2 <dateFormat2>]
        Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only
        fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.

  [--reference <reference>]
        Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be
        referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement
        key.

  [--findReplace <findReplace>]
        Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded
        quotes must be escaped.

  [--findReplaceRegex <findReplaceRegex>]
        Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values
        containing a delimiter. Embedded quotes must be doubled.

  [--list <list>]
        Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a
        delimiter. Embedded quotes must be doubled.

  [--list2 <list2>]
        Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a
        delimiter. Embedded quotes must be doubled.

  [--options <options>]
        Comma separated list of support, experimental, or other client or action specific options.

  [--continue]
        Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors
        like not found errors on remove actions.

  [--simulate]
        Simulate running actions. Log the action that would be taken.

  [--append]
        For some actions using the file parameter, append will append output to the existing file.

  [--clearFileBeforeAppend]
        For run actions, this option will automatically clear an existing file on the first append requested.

  [--parameters <parameters>]
        Client specific parameters.

  [--jiraServer <jiraServer>]
        Server parameter for JIRA actions.

  [--confluenceServer <confluenceServer>]
        Server parameter for Confluence actions.

  [--bambooServer <bambooServer>]
        Server parameter for Bamboo actions.

  [--bitbucketServer <bitbucketServer>]
        Server parameter for Bitbucket actions.

  [--hipchatServer <hipchatServer>]
        Server parameter for HipChat actions.

  [--crucibleServer <crucibleServer>]
        Server parameter for Crucible actions.

  [--fisheyeServer <fisheyeServer>]
        Server parameter for FishEye actions.

  [--servicedeskServer <servicedeskServer>]
        Server parameter for Service Desk actions.

  [--upmServer <upmServer>]
        Server parameter for UPM actions.

  [(-u|--user) <user>]
        User name for remote access.

  [(-p|--password) <password>]
        User password for remote access.

  [--help]
        Prints this help message.


Valid actions (case insensitive):

run - Run actions from a file or standard input.
	 Required parameters: file or standard input
	 Optional parameters: common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input
	 Required parameters: sql or file or standard input
	 Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword,
	 propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file.
	 Required parameters: file
	 Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromList - Run actions for each entry in a list.
	 When file is provided, each action in the file augmented by the common parameter will be run for each entry.
	 Otherwise, just the action specified by the common parameter will be run.
	 Available replacement variables are entry, entry2.
	 Required parameters: list
	 Optional parameters: list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
getClientInfo - Get information about the this client tool.
	 Optional parameters: outputFormat, file, append, encoding
	 Output formats: 1 - basic, 2 - JVM
jira - Use the JIRA CLI client to run an action.
	 Required parameters: common
confluence - Use the Confluence CLI client to run an action.
	 Required parameters: common
bamboo - Use the Bamboo CLI client to run an action.
	 Required parameters: common
bitbucket - Use the Bitbucket CLI client to run an action.
	 Required parameters: common
hipchat - Use the HipChat CLI client to run an action.
	 Required parameters: common
crucible - Use the Crucible CLI client to run an action.
	 Required parameters: common
fisheye - Use the FishEye CLI client to run an action.
	 Required parameters: common
servicedesk - Use the Service Desk CLI client to run an action.
	 Required parameters: common
upm - Use the UPM CLI client to run an action.
	 Required parameters: common
Appfire Command Line Interface (CLI)

Atlassian CLI Help text - 6.2.0

Related information for 6.2.0

Help Text
