We're updating the issue view to help you get more done. 

Improve client help text output for the action list

Description

--help for a client outputs a complete parameter list in a standard format produced by the JSAP parser. However, we add additional information that lists all the actions available for the client. Previous to this improvement, the output was a hard to read text format.

This improvement changes the output of the action list to a table format very similar to the online [ACLI:Action Reference]. This displays best if your terminal screen width is as at least 132 characters, otherwise some columns may not appear and severe wrapping may occur - see for more information.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 Valid actions (case insensitive): ┌───────────────┬──────────────────────────────────────────────────────────────────┬─────────────────────────────────┬──────────────────────────────────────────────────────────────────┬─────────────────────┬─────────────┐ │ Name │ Description │ Required │ Optional │ Output │ Replacement │ │ │ │ │ │ Formats │ Variables │ ├───────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────┼─────────────┤ │ getClientInfo │ Get information about this client tool. │ │ outputFormat, file, append, encoding │ 1 - basic │ │ │ │ │ │ │ 2 - JVM │ │ │ │ │ │ │ 11 - action list │ │ │ │ │ │ │ 12 - parameter list │ │ ├───────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────┼─────────────┤ │ run │ Run actions from a file, list of input parameters, or standard │ file or input or standard input │ common, input, continue, simulate, file, encoding, │ │ │ │ │ input. │ │ clearFileBeforeAppend, findReplace, findReplaceRegex │ │ │ ├───────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────┼─────────────┤ │ runIf │ Run actions only if a regex based condition is met. Other │ value │ options, common, input, continue, simulate, file, encoding, │ │ │ │ │ parameters and behavior are the same as the run action. By │ regex │ clearFileBeforeAppend, findReplace, findReplaceRegex │ │ │ │ │ default the regex is used as a find operation in the value. │ file or input or standard input │ │ │ │ │ │ Options parameter can be set to one or more of the following to │ │ │ │ │ │ │ modify the default behavior: literal - to treat the regex string │ │ │ │ │ │ │ as a literal string, exact - to require an exact match of the │ │ │ │ │ │ │ value, negative - to reverse the condition so a match means do │ │ │ │ │ │ │ NOT run action. │ │ │ │ │ ├───────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────┼─────────────┤ │ runFromSql │ Run actions generated by SQL provided by the sql parameter, a │ sql or file │ driver, database, host, port, url, dbUser, dbPassword, │ │ │ │ │ file, or standard input │ │ propertyFile, common, input, continue, simulate, encoding, │ │ │ │ │ │ │ clearFileBeforeAppend, findReplace, findReplaceRegex │ │ │ ├───────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────┼─────────────┤ │ runFromCsv │ Run actions generated from a CSV file. │ file │ propertyFile, common, input, continue, simulate, encoding, │ │ │ │ │ │ │ clearFileBeforeAppend, findReplace, findReplaceRegex │ │ │ ├───────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────┼──────────────────────────────────────────────────────────────────┼─────────────────────┼─────────────┤ │ runFromList │ Run actions for each entry in a list with corresponding entry │ list │ list2, common, input, continue, simulate, file, encoding, │ │ entry │ │ │ replacement variable. When file is provided, each action in the │ │ clearFileBeforeAppend, findReplace, findReplaceRegex │ │ entry2 │ │ │ file augmented by the common parameter will be run for each │ │ │ │ options │ │ │ entry. Otherwise, just the action specified by the common │ │ │ │ │ │ │ parameter will be run. When available, list2 entries provide │ │ │ │ │ │ │ values for the entry2 replacement variable. By default, the │ │ │ │ │ │ │ entry2 replacement variable is set in parallel with entry │ │ │ │ │ │ │ replacement variables for each action run. However, if --options │ │ │ │ │ │ │ listProcessing=serial is specified, each combination of entries │ │ │ │ │ │ │ from list and list2 will cause an action to run. │ │ │ │ │ └───────────────┴──────────────────────────────────────────────────────────────────┴─────────────────────────────────┴──────────────────────────────────────────────────────────────────┴─────────────────────┴─────────────┘

Environment

None

Status

Assignee

Bob Swift [Bob Swift Atlassian Apps]

Reporter

Bob Swift [Bob Swift Atlassian Apps]

Labels

None

Support Entitlement

None

Fix versions

Priority

Major