Related information for

Actions

	Action	Category	Description	Required parameters	Optional parameters	Output formats
1	Reference#getChangeSetList	Change Sets	Get a list of change sets for path.	Reference#repository, Reference#path	Reference#file, Reference#columns, Reference#encoding
2	Reference#getChangeSet	Change Sets	Get change set details.	Reference#repository, Reference#change	Reference#file, Reference#columns, Reference#encoding
3	Reference#getClientInfo	Info	Get information about the this client tool.		Reference#outputFormat, Reference#file, Reference#append, Reference#encoding	1 - basic 2 - JVM
4	Reference#getPathHistoryList	Paths	Get a path history list.	Reference#repository	Reference#path, Reference#file, Reference#columns, Reference#encoding
5	Reference#getPathList	Paths	Get a list of paths under a given path.	Reference#repository	Reference#path, Reference#file, Reference#columns, Reference#encoding
6	Reference#getRepositoryList	Repositories	Get a list of repositories.		Reference#file, Reference#columns, Reference#encoding
7	Reference#getRevision	Revisions	Get revision details.	Reference#repository, Reference#path, Reference#revision	Reference#file, Reference#columns, Reference#encoding
8	Reference#getServerInfo	Info	Get information about the Crucible server.		Reference#dateFormat, Reference#file, Reference#append, Reference#encoding
9	Reference#getTagList	Lists	Get a list of tags for a revision.	Reference#repository, Reference#path, Reference#revision	Reference#file, Reference#columns, Reference#encoding
10	Reference#login	Misc	Login to remote server. Returns login token.	Reference#password	Reference#user
11	Reference#logout	Misc	Logout of remote server.
12	Reference#query	Query	Run an EyeQL query.	Reference#repository, Reference#query	Reference#file
13	Reference#runFromCsv	CSV	Run actions generated from a CSV file.	Reference#file	Reference#common, Reference#propertyFile, Reference#continue, Reference#quiet, Reference#simulate, Reference#clearFileBeforeAppend, Reference#encoding, Reference#findReplace, Reference#findReplaceRegex
14	Reference#runFromList	Run	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.	Reference#list	Reference#list2, Reference#file, Reference#common, Reference#continue, Reference#quiet, Reference#simulate, Reference#clearFileBeforeAppend, Reference#encoding, Reference#findReplace, Reference#findReplaceRegex
15	Reference#runFromSql	Run	Run actions generated by SQL provided by the sql parameter, a file, or standard input	Reference#sql or Reference#file or standard input	Reference#common, Reference#driver, Reference#database, Reference#host, Reference#port, Reference#url, Reference#dbUser, Reference#dbPassword, Reference#propertyFile, Reference#continue, Reference#simulate, Reference#clearFileBeforeAppend, Reference#encoding, Reference#findReplace, Reference#findReplaceRegex
16	Reference#run	Run	Run actions from a file or standard input.	Reference#file or standard input	Reference#common, Reference#continue, Reference#simulate, Reference#clearFileBeforeAppend, Reference#encoding, Reference#findReplace, Reference#findReplaceRegex
17	Reference#validateLicense	Misc	Validates the CLI Connector is enabled and licensed on the server.

Parameter Tips

Common parameters

A few common parameters are available that are not specifically listed as optional parameters for each action: help, verbose, debug, quiet, special, dateFormat, dateFormat2, and outputType. Similarly for database related parameters that are optional for all get list actions: url, dbUser, dbPassword, database, driver, dbJar, host, port, dbCreateTable, dbTable, dbTableKeys, afterSql, and propertyFile.

Tips

To get help for a specific action, type the action followed by --help - example: --action getProjectList --help
Use double dash for multi-letter parameters - example: --help
Use single dash for single letter parameters indicated in the Short column in parameter help - example: -v
When parameters are specified, most need a value as indicated by a check in the Value column in parameter help - example: --action addPage
Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
- An incorrect case parameter will result in an unknown parameter error and show action help with correctly cased parameter (9.8 or higher)
Some parameters become required once a specific action is chosen. This is indicated in the action help text as required.
Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same and cannot both be specified
Some parameters have default values, if so, they are indicated in the help text
Values that contain blanks or some special characters (platform specific) must be enclosed by double quotes - example: --title "this is my title"
Quoting rules in commands can vary by terminal environment:
- Windows command terminals or run action scripts for all platforms: embedded double quotes within a double quoted string must be escaped by doubling the double quote - example: –common "-a addComment --comment ""This is an example of a double quoted string inside a double quote"" "
- Linux and Mac/OSX command terminals require standard Linux style escaping: embedded double quotes within a double quoted string can be escaped with a \ - example: –common " -a addComment --comment \"This is an example of a double quoted string inside a double quote\" "
- Run CLI Actions usage: embedded double quotes within a double quoted string can be escaped by doubling the double quote (first example above)
- A single quote sometimes can used in place of a double quotes on some command terminal environments - example: –common '-a addComment --comment "This is an example of a double quoted string inside a double quote" '
Some parameters allow entry of a comma separated list of values, values containing a comma must be enclosed in single quotes - example: --custom "'first:a,b,c', second:x". Embedded single quotes within a quoted string must be doubled
Some text fields support the automatic conversion of " \n " (blanks are significant) to be replaced with a new line character - example: --description "A multi-line text field: \n # line 1 \n # line 2"
In run scripts and automations:
- Lines with lead # are treated as comments and are logged when run
- Lines with lead ## are treated as comments and NOT logged when run (12.1 and higher)

Special parameter

Some special characters are difficult to deal with or make action text very complicated. This is because they have special meaning in either the OS command terminal handling, the tool's command line parsing, or the tool's use of separators (like comma or colon separated lists). As a convenience to avoid some of these nasty situations, a special parameter was implemented to allow alternate characters to be used instead of (or in addition to) the problematic characters within parameter values. The choice of what special characters to use depends on the content so that you do not have conflicts with intended content. The special parameter works by the user providing a order specific alternate character. The alternative character is replaced with the real character after all other parsing occurs. It is implemented for many action parameters that are problematic in this area. Not all situations are covered, but, that will improve as other use cases are identified.

Position	Character	Character name	Suggested alternate	Usage
1	,	comma		Some parameters use comma separated lists.
2	:	colon	#	Some parameters use colon separated values.
3	@	at sign		Replacement variables syntax: @...@.
4	'	single quote		Used in separated lists to cover cases where content contains separator.
5	"	double quote	~	Parameters containing blanks.
6	^	caret		Substitution double quote indicator: ^^...^^. See ACLI-673 for details.

A blank in any position is ignored (no alternate provided).

Example: –special " #  ~" provides alternates for colon and double quote.

         --common "--findReplace ~something to find containing a : (colon)#replacement~"

Character Set

User and password values should be in the ISO-8859-1 character set. Also avoid characters that require escaping on your OS command terminal. Non standard characters will result in an authorization error similar to: User is not authorized to perform the request.

Parameters

	Parameter	Short	Description
1	action	a
2	afterSql		SQL to run after a successful action. Limited to specific actions at this time.
3	api		API version. Some requests produce different results based on the api version used. (default: latest)
4	append		For some actions using the file parameter, append will append output to the existing file.
5	change		Change set id.
6	clearFileBeforeAppend		For run actions, this option will automatically clear an existing file on the first append requested.
7	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.
8	comment		Comment text.
9	common		Common parameter string added to all run actions.
10	connectionTimeout		Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.
11	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.
12	cookies		Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session affinity for actions using REST APIs.
13	database		Database name is required for SQL actions.
14	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.
15	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.
16	dbCreateTable		Database table needs to be created before adding rows.
17	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
18	dbPassword		Database user password. Defaults to password.
19	dbTable		Database table name when creating or updating a database from list output.
20	dbTableKeys		Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table.
21	dbUser		Database user name. Defaults to user.
22	debug		Requests detail debug output. Optional for all actions.
23	driver		JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.
24	encoding		Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.
25	file	f	Path to file based content or result output. Use - for standard input.
26	findReplace		Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped.
27	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.
28	help		Prints this help message.
29	host		Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.
30	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.
31	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.
32	login		Login token from previous login request.
33	loginFromStandardInput	l	Get login token from standard input.
34	options		Comma separated list of support, experimental, or other client or action specific options.
35	outputFormat		Specify output format for an action. (default: 1)
36	password	p	User password for remote access.
37	path		File or directory path.
38	port		Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.
39	propertyFile		Property file with database parameters, field mappings, or client specific information.
40	query		EyeQL query.
41	quiet		Limit some output messages. Optional for all actions.
42	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.
43	replace		Replace existing entity on add, create, or similar actions.
44	repository		Repository name.
45	revision		Revision.
46	server	s	Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.
47	service		Service address extension. (default: /api/rest/)
48	simulate		Simulate running actions. Log the action that would be taken.
49	special		Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.
50	sql		SQL select statement used to generate a run script.
51	url		Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.
52	user	u	User name for remote access. (default: automation)
53	verbose	v	Requests verbose output to help with problem determination. Optional for all actions.

FishEye Command Line Interface (CLI)

Reference

On this page

Related information for

Actions

Parameter Tips

Parameters