Parameters

Parameters tell the CLI the specific details needed to perform an action. Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform the task.

The CLI requires at least one special parameter named action that tells what action to perform, without the action parameter, CLI displays help with some example actions. Parameters do not have prefixes like actions and are often specific to the app for the action.

For example, the action getServerInfo requires details about the app or server from where the information is retrieved. To obtain the required information, the server parameter is used.

The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.


--acceptType		Content type to accept for renderRequest if different than contentType.
--action	a	Requested operation to perform. Valid actions are listed separately.
--activate		Activate user.
--affectsVersions		Affects versions - comma separated names or ids.
--after		Version name or id to add a version after. Defaults to after last version. Use -1 to make it the first version.
--afterSql		SQL to run after a successful action. Limited to specific actions at this time.
--app		App key.
--append		For field value and custom field actions, this must be single field name or id. For issue related actions, the parameter can be specified multiple times for setting custom field values as a more convenient alternative to the custom parameter. Additionally for custom fields, JSON can be used. See the documentation for more details on this advanced use case. The following common client field parameter support applies. For some actions using the file parameter, append will append output to the existing file.
--appendText		Append text to existing value text for description, environment, and single and multi-value custom fields.
--assignee		Issue assignee user id. In some contexts, use -1 for automatic assignment and "" for unassigned.
--autoAdjust		Auto adjust remaining estimate when adding work entry.
--autoComponent		Automatically add components used in components parameter.
--autoGroup		Groups are automatically added when referenced in add user functions.
--autoTab		Automatically add tab used in add screen fields functions.
--autoVersion		Automatically add versions used in affectsVersions and fixVersions parameters.
--category		Project category. Administrator access required to see or use project categories.
--channel		Channel name or id to use for slack output type on get actions.
--clearFileBeforeAppend		For run actions, this option will automatically clear an existing file on the first append requested.
--cloneIssues		Clone issues when cloning a project.
--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.
--comment		Comment text.
--common		Common parameter string added to all actions in the run script.
--component		Project component name or id.
--components		Project components - comma separated names or ids.
--connectionTimeout		Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.
--contentType		Content type for post data for a web request. Any suitable value can be specified. We have defined some special values for commonly used types: XML, JSON, JSON_PATCH, HTML, FORM_URL_ENCODED.
--context		Custom field context.
--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 and already exists errors on add actions.
--cookies		Name of file to restore and persist cookies across invocations of ACLI actions.
--copyAttachments		Copy attachments when copying an issue.