Atlassian CLI 3.4.0 - Help text

3.4.0




Usage:
  all (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat
  <outputFormat>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>] [--host <host>] [--port
  <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--propertyFile <propertyFile>] [--common <common>]
  [--findReplace <findReplace>] [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--continue] [--simulate] [--parameters
  <parameters>] [(-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 (not case sensitive) are:
        
        run - Run actions from a file or standard input.
        	 Required parameters: file or standard input
        	 Optional parameters: common, continue, simulate, 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, encoding, findReplace, findReplaceRegex
        runFromCsv - Run actions generated from a CSV file.
        	 Required parameters: file
        	 Optional parameters: common, propertyFile, continue, quiet, simulate, 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 variable is entry.
        	 Required parameters: list
        	 Optional parameters: file, common, continue, quiet, simulate, encoding, findReplace, findReplaceRegex
        getClientInfo - Get information about the this client tool.
        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
        stash - Use the Stash 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

  [(-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)

  [--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. (default: localhost)

  [--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.

  [--propertyFile <propertyFile>]
        Property file with mapping information.

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

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

  [--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. Single quote values containing a delimiter. Embedded quotes must be doubled.

  [--continue]
        Continue processing even after errors are encountered.

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

  [--parameters <parameters>]
        Client specific parameters

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

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

  [--help]
        Prints this help message.