Commands
Number of available commands may change from version to version and between Cloud and Server/DC deployments. You can also access exactly the same help using --help flag with any command.
jira announcement-banner update
Updates the announcement banner configuration.
USAGE
$ jira announcement-banner update -m <value> -v public|private [-d] [-e]
FLAGS
-d, --[no-]isDismissible Flag indicating if the announcement banner can be dismissed by the user.
-e, --[no-]isEnabled Flag indicating if the announcement banner is enabled or not.
-m, --message=<value> (required) The text on the announcement banner.
-v, --visibility=<option> (required) Visibility of the announcement banner. Can be public or private.
<options: public|private>
DESCRIPTION
Updates the announcement banner configuration.
ALIASES
$ jira announcement-banner update
$ jira announcement-banner update
jira announcement-banner get
Returns the current announcement banner configuration.
USAGE
$ jira announcement-banner get
DESCRIPTION
Returns the current announcement banner configuration.
jira announcement-banner update
Updates the announcement banner configuration.
USAGE
$ jira announcement-banner update -m <value> -v public|private [-d] [-e]
FLAGS
-d, --[no-]isDismissible Flag indicating if the announcement banner can be dismissed by the user.
-e, --[no-]isEnabled Flag indicating if the announcement banner is enabled or not.
-m, --message=<value> (required) The text on the announcement banner.
-v, --visibility=<option> (required) Visibility of the announcement banner. Can be public or private.
<options: public|private>
DESCRIPTION
Updates the announcement banner configuration.
ALIASES
$ jira announcement-banner update
$ jira announcement-banner update
jira application-role update
Updates the an application role. If versionHash is passed, the request will be rejected if not the same as server.
USAGE
$ jira application-role update -k <value> [-v <value>] [-n <value>] [-g <value>] [--defaultGroups <value>]
[--selectedByDefault] [--numberOfSeats <value>] [-r <value>] [-c <value>] [--userCountDescription <value>]
[--hasUnlimitedSeats] [-p]
FLAGS
-c, --userCount=<value> The number of users counting against your license.
-g, --groups=<value> The name of the groups. You can provide multiple group name by seperating them with
comma.
-k, --key=<value> (required) The key of the application role.
-n, --name=<value> The display name of the application role.
-p, --platform Indicates if the application role belongs to Jira platform (jira-core).
-r, --remainingSeats=<value> The count of users remaining on your license.
-v, --versionHash=<value> The hash of the version to update.
--defaultGroups=<value> The name of default groups. You can provide multiple group name by seperating them
with comma.
--hasUnlimitedSeats Whether your license can have unlimited user or not.
--numberOfSeats=<value> The maximum count of users on your license.
--selectedByDefault Determines whether this application role should be selected by default on user
creation.
--userCountDescription=<value> The type of users being counted against your license.
DESCRIPTION
Updates the an application role. If versionHash is passed, the request will be rejected if not the same as server.
ALIASES
$ jira application-role update
$ jira application-role update
jira application-role get
Gets an application role.
USAGE
$ jira application-role get -k <value>
FLAGS
-k, --key=<value> (required) The key of the application role.
DESCRIPTION
Gets an application role.
jira application-role get-all
Gets all application roles.
USAGE
$ jira application-role get-all [--showHashVersion]
FLAGS
--showHashVersion Whether hash version will be shown in the response. (Only for Server)
DESCRIPTION
Gets all application roles.
jira application-role update
Updates the an application role. If versionHash is passed, the request will be rejected if not the same as server.
USAGE
$ jira application-role update -k <value> [-v <value>] [-n <value>] [-g <value>] [--defaultGroups <value>]
[--selectedByDefault] [--numberOfSeats <value>] [-r <value>] [-c <value>] [--userCountDescription <value>]
[--hasUnlimitedSeats] [-p]
FLAGS
-c, --userCount=<value> The number of users counting against your license.
-g, --groups=<value> The name of the groups. You can provide multiple group name by seperating them with
comma.
-k, --key=<value> (required) The key of the application role.
-n, --name=<value> The display name of the application role.
-p, --platform Indicates if the application role belongs to Jira platform (jira-core).
-r, --remainingSeats=<value> The count of users remaining on your license.
-v, --versionHash=<value> The hash of the version to update.
--defaultGroups=<value> The name of default groups. You can provide multiple group name by seperating them
with comma.
--hasUnlimitedSeats Whether your license can have unlimited user or not.
--numberOfSeats=<value> The maximum count of users on your license.
--selectedByDefault Determines whether this application role should be selected by default on user
creation.
--userCountDescription=<value> The type of users being counted against your license.
DESCRIPTION
Updates the an application role. If versionHash is passed, the request will be rejected if not the same as server.
ALIASES
$ jira application-role update
$ jira application-role update
jira attachment add FILE
Adds an attachment to an issue.
USAGE
$ jira attachment add FILE --issue <value> [--file <value>]
ARGUMENTS
FILE Location of file.
FLAGS
--file=<value> Location of file.
--issue=<value> (required) Issue ID or key.
DESCRIPTION
Adds an attachment to an issue.
jira attachment delete ID
Deletes an attachment from an issue.
USAGE
$ jira attachment delete ID [--id <value>]
ARGUMENTS
ID ID of attachment.
FLAGS
--id=<value> ID of attachment.
DESCRIPTION
Deletes an attachment from an issue.
jira attachment get-content
Gets the contents of an attachment. A Range header can be set to define a range of bytes within the attachment to download. See the HTTP Range header standard for details.
USAGE
$ jira attachment get-content --id <value> [-r]
FLAGS
-r, --redirect Whether a redirect is provided for the attachment download. Clients that do not automatically follow
redirects can set this to false to avoid making multiple requests to download the attachment.
--id=<value> (required) ID of attachment.
DESCRIPTION
Gets the contents of an attachment. A Range header can be set to define a range of bytes within the attachment to
download. See the HTTP Range header standard for details.
jira attachment get-jira-settings
Returns general information about the current Jira.
USAGE
$ jira attachment get-jira-settings
DESCRIPTION
Returns general information about the current Jira.
jira attachment get-metadata ID
Returns the metadata for an attachment. Note that the attachment itself is not returned.
USAGE
$ jira attachment get-metadata ID [--id <value>]
ARGUMENTS
ID ID of attachment.
FLAGS
--id=<value> ID of attachment.
DESCRIPTION
Returns the metadata for an attachment. Note that the attachment itself is not returned.
jira attachment get-metadata-for-zip ID
Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself.
USAGE
$ jira attachment get-metadata-for-zip ID [--id <value>]
ARGUMENTS
ID ID of attachment.
FLAGS
--id=<value> ID of attachment.
DESCRIPTION
Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself.
jira attachment get-thumbnails
Gets the thumbnail of an attachment.
USAGE
$ jira attachment get-thumbnails --id <value> [--fallbackToDefault] [-w <value>] [-h <value>] [-r]
FLAGS
-h, --height=<value> The maximum height to scale the thumbnail to.
-r, --redirect Whether a redirect is provided for the attachment download. Clients that do not automatically
follow redirects can set this to false to avoid making multiple requests to download the
attachment.
-w, --width=<value> The maximum width to scale the thumbnail to.
--fallbackToDefault Whether a default thumbnail is returned when the requested thumbnail is not found.
--id=<value> (required) ID of attachment.
DESCRIPTION
Gets the thumbnail of an attachment.
jira audit-record get-associated
Get details of an item associated with the changed record.
USAGE
$ jira audit-record get-associated [-o <value>] [-l <value>] [--from <value>] [--to <value>] [--projectIds <value>] [--userIds
<value>]
FLAGS
-l, --limit=<value> The maximum number of results to return.
-o, --offset=<value> The number of records to skip before returning the first result.
--from=<value> The date and time on or after which returned audit records must have been created. Example date:
2014-03-19
--projectIds=<value> List of project ids to look for. Only for server.
--to=<value> The date and time on or before which returned audit results must have been created.Example date:
2014-03-19
--userIds=<value> List of user ids to look for. Only for server.
DESCRIPTION
Get details of an item associated with the changed record.
jira audit-record get-changed
Get the list of values changed in the record event.
USAGE
$ jira audit-record get-changed [-o <value>] [-l <value>] [--from <value>] [--to <value>] [--projectIds <value>] [--userIds
<value>]
FLAGS
-l, --limit=<value> The maximum number of results to return.
-o, --offset=<value> The number of records to skip before returning the first result.
--from=<value> The date and time on or after which returned audit records must have been created. Example date:
2014-03-19
--projectIds=<value> List of project ids to look for. Only for server.
--to=<value> The date and time on or before which returned audit results must have been created. Example
date: 2014-03-19
--userIds=<value> List of user ids to look for. Only for server.
DESCRIPTION
Get the list of values changed in the record event.
jira avatar delete-universal-avatar
Deletes the system and custom avatars for a project or issue type.
USAGE
$ jira avatar delete-universal-avatar --type issuetype|project --entityId <value> --avatarId <value> [--x <value> --y <value>
--width <value>]
FLAGS
--avatarId=<value> (required) The ID of the avatar.
--entityId=<value> (required) The ID of the item the avatar is associated with.
--type=<option> (required) Type of avatar.
<options: issuetype|project>
--width=<value> The length of each side of the crop region.
--x=<value> The X coordinate of the top-left corner of the crop region.
--y=<value> The Y coordinate of the top-left corner of the crop region.
DESCRIPTION
Deletes the system and custom avatars for a project or issue type.
jira avatar delete-user-avatar
Deletes a custom avatar from a user. Note that system avatars cannot be deleted.
USAGE
$ jira avatar delete-user-avatar -u <value> --avatarId <value>
FLAGS
-u, --user=<value> (required) The username or email.
--avatarId=<value> (required) The ID of the avatar.
DESCRIPTION
Deletes a custom avatar from a user. Note that system avatars cannot be deleted.
jira avatar get-all-user-avatar
Returns all user avatars for specified user.
USAGE
$ jira avatar get-all-user-avatar -u <value>
FLAGS
-u, --user=<value> (required) The username or email.
DESCRIPTION
Returns all user avatars for specified user.
jira avatar get-image-by-id
Downloads a project or issue type avatar image by ID .
USAGE
$ jira avatar get-image-by-id (--fileName <value> -f png|svg) -t issuetype|project -i <value> [--size
xsmall|small|medium|large|xlarge]
FLAGS
-f, --format=<option> The format to return the avatar image in. If not provided the original content format is
returned.
<options: png|svg>
-i, --id=<value> (required) The ID of the avatar.
-t, --type=<option> (required) The icon type of the avatar.
<options: issuetype|project>
--fileName=<value> (required) File name that image will be saved in.
--size=<option> The size of the avatar image. If not provided the default size is returned.
<options: xsmall|small|medium|large|xlarge>
DESCRIPTION
Downloads a project or issue type avatar image by ID .
jira avatar get-image-by-owner
Downloads the avatar image for a project or issue type into given file name.
USAGE
$ jira avatar get-image-by-owner (--fileName <value> -f png|svg) -t issuetype|project -i <value> [--size
xsmall|small|medium|large|xlarge]
FLAGS
-f, --format=<option> The format to return the avatar image in. If not provided the original content format is
returned.
<options: png|svg>
-i, --entityId=<value> (required) The ID of the project or issue type the avatar belongs to.
-t, --type=<option> (required) The icon type of the avatar.
<options: issuetype|project>
--fileName=<value> (required) File name that image will be saved in.
--size=<option> The size of the avatar image. If not provided the default size is returned.
<options: xsmall|small|medium|large|xlarge>
DESCRIPTION
Downloads the avatar image for a project or issue type into given file name.
jira avatar get-image-by-type
Downloads the default project or issue type avatar image into given file name.
USAGE
$ jira avatar get-image-by-type (--fileName <value> -f png|svg) -t issuetype|project [--size
xsmall|small|medium|large|xlarge]
FLAGS
-f, --format=<option> The format to return the avatar image in. If not provided the original content format is
returned.
<options: png|svg>
-t, --type=<option> (required) The icon type of the avatar.
<options: issuetype|project>
--fileName=<value> (required) File name that image will be saved in.
--size=<option> The size of the avatar image. If not provided the default size is returned.
<options: xsmall|small|medium|large|xlarge>
DESCRIPTION
Downloads the default project or issue type avatar image into given file name.
jira avatar get-system-avatars
Returns all system avatars of the given type.
USAGE
$ jira avatar get-system-avatars --type issuetype|project|user
FLAGS
--type=<option> (required) Type of avatar.
<options: issuetype|project|user>
DESCRIPTION
Returns all system avatars of the given type.
jira avatar get-universal-avatars
Returns the system and custom avatars for a project or issue type.
USAGE
$ jira avatar get-universal-avatars --type issuetype|project --entityId <value> [--x <value> --y <value> --width
<value>]
FLAGS
--entityId=<value> (required) The ID of the item the avatar is associated with.
--type=<option> (required) Type of avatar.
<options: issuetype|project>
--width=<value> The length of each side of the crop region.
--x=<value> The X coordinate of the top-left corner of the crop region.
--y=<value> The Y coordinate of the top-left corner of the crop region.
DESCRIPTION
Returns the system and custom avatars for a project or issue type.
jira avatar set-user-avatar
Sets the user avatar to an already uploaded/existing avatar.
USAGE
$ jira avatar set-user-avatar -u <value> --avatarId <value>
FLAGS
-u, --user=<value> (required) The username or email.
--avatarId=<value> (required) The ID of the avatar.
DESCRIPTION
Sets the user avatar to an already uploaded/existing avatar.
jira avatar upload-universal-avatar AVATARFILE
Uploads a custom avatar for a project or issue type.
USAGE
$ jira avatar upload-universal-avatar AVATARFILE --type issuetype|project --entityId <value> [--x <value> --y <value> --width
<value>]
ARGUMENTS
AVATARFILE Location of avatar file
FLAGS
--entityId=<value> (required) The ID of the item the avatar is associated with.
--type=<option> (required) Type of avatar.
<options: issuetype|project>
--width=<value> The length of each side of the crop region.
--x=<value> The X coordinate of the top-left corner of the crop region.
--y=<value> The Y coordinate of the top-left corner of the crop region.
DESCRIPTION
Uploads a custom avatar for a project or issue type.
jira avatar upload-user-avatar AVATARFILE
Uploads an avatar for a user.
USAGE
$ jira avatar upload-user-avatar AVATARFILE -u <value> [--x <value> --y <value> --width <value>]
ARGUMENTS
AVATARFILE Location of avatar file
FLAGS
-u, --user=<value> (required) The username or email.
--width=<value> The length of each side of the crop region.
--x=<value> The X coordinate of the top-left corner of the crop region.
--y=<value> The Y coordinate of the top-left corner of the crop region.
DESCRIPTION
Uploads an avatar for a user.
jira comment-property delete-property
Deletes a property for a comment.
USAGE
$ jira comment-property delete-property --commentId <value> --key <value>
FLAGS
--commentId=<value> (required) Comment ID.
--key=<value> (required) Property key.
DESCRIPTION
Deletes a property for a comment.
jira comment-property get-property
Gets the value of a property for a comment.
USAGE
$ jira comment-property get-property --commentId <value> --key <value>
FLAGS
--commentId=<value> (required) Comment ID.
--key=<value> (required) Property key.
DESCRIPTION
Gets the value of a property for a comment.
jira comment-property get-property-keys
Returns the keys of all the properties of a comment.
USAGE
$ jira comment-property get-property-keys --commentId <value>
FLAGS
--commentId=<value> (required) Comment ID.
DESCRIPTION
Returns the keys of all the properties of a comment.
jira comment-property set-property
Creates or updates the value of a property for a comment.
USAGE
$ jira comment-property set-property --commentId <value> --key <value> --value <value>
FLAGS
--commentId=<value> (required) Comment ID.
--key=<value> (required) Property key.
--value=<value> (required) Non-empty JSON blob. The maximum length is 32768 characters.
DESCRIPTION
Creates or updates the value of a property for a comment.
jira comment add
Adds a comment.
USAGE
$ jira comment add --issue <value> --body <value> [--visibilityType role|group --visibilityValue <value>]
[--visibility <value> | ]
FLAGS
--body=<value> (required) Body of the comment. For cloud this can be in Atlassian Document Format. For
Server/DC this is a string.
--issue=<value> (required) Issue ID or key.
--visibility=<value> Visibility type and value in the form role/role_name or group/group_name.
--visibilityType=<option> Visibility of type of comment.
<options: role|group>
--visibilityValue=<value> Visibility type specific value. Role or group name.
DESCRIPTION
Adds a comment.
jira comment delete
Deletes a comment.
USAGE
$ jira comment delete --issue <value> --commentId <value>
FLAGS
--commentId=<value> (required) Comment ID.
--issue=<value> (required) Issue ID or key.
DESCRIPTION
Deletes a comment.
jira comment get
Returns a comment.
USAGE
$ jira comment get --issue <value> --commentId <value>
FLAGS
--commentId=<value> (required) Comment ID.
--issue=<value> (required) Issue ID or key.
DESCRIPTION
Returns a comment.
jira comment get-for-issue [ISSUE]
Returns comments for an issue.
USAGE
$ jira comment get-for-issue [ISSUE] [--issue <value>]
ARGUMENTS
ISSUE Issue ID or key.
FLAGS
--issue=<value> Issue ID or key.
DESCRIPTION
Returns comments for an issue.
jira comment get-with-ids
Gets comments with specified IDs.
USAGE
$ jira comment get-with-ids --id <value>
FLAGS
--id=<value>... (required) Comment ID.
DESCRIPTION
Gets comments with specified IDs.
jira comment update
Updates a comment.
USAGE
$ jira comment update --commentId <value> --issue <value> --body <value> [--visibilityType role|group
--visibilityValue <value>] [--visibility <value> | ]
FLAGS
--body=<value> (required) Body of the comment. For cloud this can be in Atlassian Document Format. For
Server/DC this is a string.
--commentId=<value> (required) Comment ID.
--issue=<value> (required) Issue ID or key.
--visibility=<value> Visibility type and value in the form role/role_name or group/group_name.
--visibilityType=<option> Visibility of type of comment.
<options: role|group>
--visibilityValue=<value> Visibility type specific value. Role or group name.
DESCRIPTION
Updates a comment.
jira config add
Adds a new Jira site configuration.
USAGE
$ jira config add [-s <value>] [-u <value> -p <value>] [-t <value> []] [-a <value>] [-h]
FLAGS
-a, --alias=<value> alias for the site
-e, --email=<value> e-mail for authentication
-h, --help Show CLI help.
-p, --password=<value> password for username/password authentication
-s, --site=<value> URL of Jira site
-t, --token=<value> oauth authentication token associated with e-mail
-u, --username=<value> username for username/password authentication
DESCRIPTION
Adds a new Jira site configuration.
jira config delete [SITE]
Deletes site with given alias.
USAGE
$ jira config delete [SITE] [-s <value>]
ARGUMENTS
SITE Alias of the site
FLAGS
-s, --site=<value> Alias of the site
DESCRIPTION
Deletes site with given alias.
jira config get-default
Gets alias of default Site.
USAGE
$ jira config get-default
DESCRIPTION
Gets alias of default Site.
jira config list
Lists all sites.
USAGE
$ jira config list
DESCRIPTION
Lists all sites.
jira config set-default [SITE]
Sets default Site.
USAGE
$ jira config set-default [SITE] [-s <value>]
ARGUMENTS
SITE Alias of the site
FLAGS
-s, --site=<value> Alias of the site
DESCRIPTION
Sets default Site.
jira dashboard-gadget add
Adds a gadget to the dashboard.
USAGE
$ jira dashboard-gadget add -i <value> [-m <value> | -u <value>] [--color blue|red|yellow|green|cyan|purple|gray|white]
[--position <value>] [--title <value>] [--ignoreUriAndModuleKeyValidation]
FLAGS
-i, --dashboardId=<value> (required) Dashboard ID.
-m, --moduleKey=<value> The module key of the gadget type.
-u, --uri=<value> The URI of the gadget type.
--color=<option> The color of the gadget.
<options: blue|red|yellow|green|cyan|purple|gray|white>
--ignoreUriAndModuleKeyValidation Whether to ignore the validation of module key and URI. For example, when a gadget
is created that is a part of an application that isn't installed.
--position=<value> The position of the gadget. When the gadget is placed into the position, other
gadgets in the same column are moved down to accommodate it. KEYS: [row, column]
Example usage: --position=row=1,column=2
--title=<value> The title of the gadget.
DESCRIPTION
Adds a gadget to the dashboard.
jira dashboard-gadget get-availables
Gets a list of all available gadgets that can be added to all dashboards.
USAGE
$ jira dashboard-gadget get-availables
DESCRIPTION
Gets a list of all available gadgets that can be added to all dashboards.
jira dashboard-gadget remove
Removes a gadget from dashboard.
USAGE
$ jira dashboard-gadget remove -d <value> -g <value>
FLAGS
-d, --dashboardId=<value> (required) Dashboard ID.
-g, --gadgetId=<value> (required) Gadget ID.
DESCRIPTION
Removes a gadget from dashboard.
jira dashboard-gadget search
Searches dashboard gadgets.
USAGE
$ jira dashboard-gadget search -d <value> [-m <value>] [-u <value>] [-g <value>]
FLAGS
-d, --dashboardId=<value> (required) Dashboard ID.
-g, --gadgetId=<value>... Gadget ID. You can provide multiple value by repeating this flag.
-m, --moduleKey=<value>... Module key. You can provide multiple value by repeating this flag.
-u, --uri=<value>... Gadget uri. You can provide multiple value by repeating this flag.
DESCRIPTION
Searches dashboard gadgets.
jira dashboard-gadget update
Updates a dashboard gadget.
USAGE
$ jira dashboard-gadget update -d <value> -g <value> [--color blue|red|yellow|green|cyan|purple|gray|white] [--position
<value>] [--title <value>]
FLAGS
-d, --dashboardId=<value> (required) Dashboard ID.
-g, --gadgetId=<value> (required) Gadget ID.
--color=<option> The color of the gadget.
<options: blue|red|yellow|green|cyan|purple|gray|white>
--position=<value> The position of the gadget. When the gadget is placed into the position, other gadgets in
the same column are moved down to accommodate it. KEYS: [row, column]
Example usage: --position=row=1,column=2
--title=<value> The title of the gadget.
DESCRIPTION
Updates a dashboard gadget.
jira dashboard-item-property delete
My description
USAGE
$ jira dashboard-item-property delete -d <value> -i <value> -k <value>
FLAGS
-d, --dashboardId=<value> (required) The ID of the dashboard.
-i, --itemId=<value> (required) The ID of the dashboard item.
-k, --propertyKey=<value> (required) The key of the dashboard item property.
DESCRIPTION
My description
jira dashboard-item-property get
Gets the key and value of a dashboard item property
USAGE
$ jira dashboard-item-property get -d <value> -i <value> -k <value>
FLAGS
-d, --dashboardId=<value> (required) The ID of the dashboard.
-i, --itemId=<value> (required) The ID of the dashboard item.
-k, --propertyKey=<value> (required) The key of the dashboard item property.
DESCRIPTION
Gets the key and value of a dashboard item property
jira dashboard-item-property get-keys
Gets keys of all properties for a dashboard item.
USAGE
$ jira dashboard-item-property get-keys -d <value> -i <value>
FLAGS
-d, --dashboardId=<value> (required) The ID of the dashboard.
-i, --itemId=<value> (required) The ID of the dashboard item.
DESCRIPTION
Gets keys of all properties for a dashboard item.
jira dashboard-item-property set [JSONBODY]
Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
USAGE
$ jira dashboard-item-property set [JSONBODY] -d <value> -i <value> -k <value>
ARGUMENTS
JSONBODY Dashboard Item property set request in JSON format.
FLAGS
-d, --dashboardId=<value> (required) The ID of the dashboard.
-i, --itemId=<value> (required) The ID of the dashboard item.
-k, --propertyKey=<value> (required) The key of the dashboard item property.
DESCRIPTION
Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
jira dashboard add-edit-permission
Adds an edit permission to a dashboard.
USAGE
$ jira dashboard add-edit-permission -i <value> --type user|group|project|projectRole|global|authenticated|project-unknown|role
[--project <value>] [-g <value>] [--projectRoleId <value> ] [-u <value>]
FLAGS
-g, --group=<value> The name or id of the group that you want to add users to.
-i, --id=<value> (required) The ID of the dashboard.
-u, --user=<value> User's account Id or username or email.
--project=<value> Project ID.
--projectRoleId=<value> Role ID.
--type=<option> (required) The type of edit permissions.
<options: user|group|project|projectRole|global|authenticated|project-unknown|role>
DESCRIPTION
Adds an edit permission to a dashboard.
jira dashboard add-share-permission
Adds an share permission to a dashboard.
USAGE
$ jira dashboard add-share-permission -i <value> --type user|group|project|projectRole|global|authenticated|project-unknown|role
[--project <value>] [-g <value>] [--projectRoleId <value> ] [-u <value>]
FLAGS
-g, --group=<value> The name or id of the group that you want to add users to.
-i, --id=<value> (required) The ID of the dashboard.
-u, --user=<value> User's account Id or username or email.
--project=<value> Project ID.
--projectRoleId=<value> Role ID.
--type=<option> (required) The type of share permissions.
<options: user|group|project|projectRole|global|authenticated|project-unknown|role>
DESCRIPTION
Adds an share permission to a dashboard.
jira dashboard copy
Copies a dashboard.
USAGE
$ jira dashboard copy -i <value> [-n <value>] [-d <value>]
FLAGS
-d, --description=<value> The description of the dashboard.
-i, --id=<value> (required) The ID of the dashboard to update.
-n, --name=<value> The name of the dashboard.
DESCRIPTION
Copies a dashboard.
jira dashboard create
Creates a dashboard
USAGE
$ jira dashboard create -n <value> [-d <value>]
FLAGS
-d, --description=<value> The description of the dashboard.
-n, --name=<value> (required) The name of the dashboard.
DESCRIPTION
Creates a dashboard
jira dashboard delete
Deletes a dashboard.
USAGE
$ jira dashboard delete -i <value>
FLAGS
-i, --id=<value> (required) The ID of the dashboard to delete.
DESCRIPTION
Deletes a dashboard.
jira dashboard get [ID]
Gets a dashboard.
USAGE
$ jira dashboard get [ID] [-i <value>]
ARGUMENTS
ID The ID of the dashboard.
FLAGS
-i, --id=<value>... The ID of the dashboard.
DESCRIPTION
Gets a dashboard.
jira dashboard get-all
Gets a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
USAGE
$ jira dashboard get-all [--filter my|favourite] [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--filter=<option> The filter applied to the list of dashboards.
<options: my|favourite>
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned
dashboards.
jira dashboard get-permissions
Gets edit or share permissions that a dashboard has.
USAGE
$ jira dashboard get-permissions -i <value> -t edit|share
FLAGS
-i, --id=<value> (required) The ID of the dashboard.
-t, --type=<option> (required) Permission type you want to get.
<options: edit|share>
DESCRIPTION
Gets edit or share permissions that a dashboard has.
jira dashboard search
Searches all dashboards.
USAGE
$ jira dashboard search [--orderBy description|favourite_count|id|is_favourite|name|owner] [--orderDirection
ASC|DSC] [--query <value>] [-u <value>] [-g <value>] [-p <value>] [--status active|archived|deleted] [--expand
description|owner|viewUrl|favourite|favouritedCount|favouritedCount] [--all | --startAt <value> | --maxResults
<value>]
FLAGS
-g, --group=<value> The name or id of the group that you want to add users to.
-p, --project=<value> Project id or key
-u, --user=<value> User account ID or username or email used to return dashboards with the matching dashboard
owner's accountId.
--all Whether all responses are returned.
--expand=<option> Use expand to include additional information about dashboard in the response.
<options: description|owner|viewUrl|favourite|favouritedCount|favouritedCount>
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> [default: name]
<options: description|favourite_count|id|is_favourite|name|owner>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
--status=<option> The status to filter by. It may be active, archived or deleted.
<options: active|archived|deleted>
DESCRIPTION
Searches all dashboards.
jira dashboard update
Updates a dashboard.
USAGE
$ jira dashboard update -i <value> [-n <value>] [-d <value>]
FLAGS
-d, --description=<value> The description of the dashboard.
-i, --id=<value> (required) The ID of the dashboard to update.
-n, --name=<value> The name of the dashboard.
DESCRIPTION
Updates a dashboard.
jira filter-sharing add-edit-permission
Add edit permission for a filter.
USAGE
$ jira filter-sharing add-edit-permission -i <value> --type user|group|project|projectRole|global|authenticated|project-unknown|role
[-g <value>] [--projectRoleId <value> -p <value>] [-u <value>]
FLAGS
-g, --group=<value> The name or id of the group that you want to add users to.
-i, --id=<value> (required) Filter ID
-p, --project=<value> Project id or key
-u, --user=<value> User's account Id or email or username.
--projectRoleId=<value> Role ID
--type=<option> (required) The type of edit permissions.
<options: user|group|project|projectRole|global|authenticated|project-unknown|role>
DESCRIPTION
Add edit permission for a filter.
jira filter-sharing add-share-permission
Add share permission for filter.
USAGE
$ jira filter-sharing add-share-permission -i <value> --type user|group|project|projectRole|global|authenticated|project-unknown|role
[--projectRoleId <value> -p <value>] [-g <value>] [--userKey <value> | -u <value>] [--view] [--edit] [--rights
<value>]
FLAGS
-g, --group=<value> The name or id of the group that you want to add users to.
-i, --filterId=<value> (required) Filter ID
-p, --project=<value> Project Id or key
-u, --user=<value> User's account Id or username or email.
--[no-]edit Edit permission. (For server)
--projectRoleId=<value> Role ID
--rights=<value> The rights for the share permission.
--type=<option> (required) The type of share permissions.
<options: user|group|project|projectRole|global|authenticated|project-unknown|role>
--userKey=<value> The user key. Only applicable to server.
--[no-]view View permission. (For server)
DESCRIPTION
Add share permission for filter.
jira filter-sharing delete-permission
Delete share permission of a filter.
USAGE
$ jira filter-sharing delete-permission -i <value> --permissionId <value>
FLAGS
-i, --filterId=<value> (required) Filter's ID.
--permissionId=<value> (required) Permission ID
DESCRIPTION
Delete share permission of a filter.
jira filter-sharing get-default-scope
Set default sharing scope for filters.
USAGE
$ jira filter-sharing get-default-scope
DESCRIPTION
Set default sharing scope for filters.
jira filter-sharing get-edit-permissions
Get filter's share permissions.
USAGE
$ jira filter-sharing get-edit-permissions -i <value>
FLAGS
-i, --filterId=<value> (required) Filter's ID.
DESCRIPTION
Get filter's share permissions.
jira filter-sharing get-permission
Get a share permission.
USAGE
$ jira filter-sharing get-permission -i <value> --permissionId <value>
FLAGS
-i, --filterId=<value> (required) Filter's ID.
--permissionId=<value> (required) Permission ID
DESCRIPTION
Get a share permission.
jira filter-sharing get-share-permissions
Get filter's share permissions.
USAGE
$ jira filter-sharing get-share-permissions -i <value>
FLAGS
-i, --filterId=<value> (required) Filter's ID.
DESCRIPTION
Get filter's share permissions.
jira filter-sharing set-default-scope
Set default sharing scope for filters.
USAGE
$ jira filter-sharing set-default-scope --scope GLOBAL|PRIVATE|AUTHENTICATED
FLAGS
--scope=<option> (required) The scope of the default sharing for new filters and dashboards
<options: GLOBAL|PRIVATE|AUTHENTICATED>
DESCRIPTION
Set default sharing scope for filters.
jira filter add-favourite
Add filter to your favourites.
USAGE
$ jira filter add-favourite -i <value>
FLAGS
-i, --filterId=<value> (required) Filter's ID.
DESCRIPTION
Add filter to your favourites.
jira filter change-owner
Change filter's owner.
USAGE
$ jira filter change-owner -i <value> -u <value>
FLAGS
-i, --filterId=<value> (required) Filter's ID.
-u, --user=<value> (required) User's account ID or username or email.
DESCRIPTION
Change filter's owner.
jira filter create
Create a filter.
USAGE
$ jira filter create -n <value> [-d <value>] [--jql <value>] [-f] [--editable] [--overrideSharePermissions]
FLAGS
-d, --description=<value> A description of the filter.
-f, --favourite Whether the filter is selected as a favorite.
-n, --name=<value> (required) Filter's name.
--editable Whether the filter is editable or not.
--jql=<value> The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
--overrideSharePermissions Whether share permissions are overridden to enable filters with any share permissions to
be created.
DESCRIPTION
Create a filter.
jira filter delete
Delete a filter.
USAGE
$ jira filter delete -i <value>
FLAGS
-i, --id=<value> (required) Filter's ID.
DESCRIPTION
Delete a filter.
jira filter get [ID]
Get a filter.
USAGE
$ jira filter get [ID] [-i <value>] [-e <value>] [--overrideSharePermissions]
ARGUMENTS
ID Filter's ID.
FLAGS
-e, --expand=<value>
Use expand to include additional information about filter in the response.
Options:
•sharedUsers (Returns the users that the filter is shared with.)
•subscriptions (Returns the users that are subscribed to the filter.)
NOTE:
•Return values are limited to 1000, to access additional data use subscriptions[startIndex:endIndex] or
sharedUsers[startIndex:endIndex]
-i, --id=<value>...
Filter's ID.
--overrideSharePermissions
Whether share permissions are overridden to enable filters with any share permissions to be returned.
DESCRIPTION
Get a filter.
jira filter get-columns
Get Filter's columns.
USAGE
$ jira filter get-columns -i <value>
FLAGS
-i, --id=<value> (required) Filter's ID.
DESCRIPTION
Get Filter's columns.
jira filter get-details
Get more details about filter.
USAGE
$ jira filter get-details -i <value> -e <value> [--overrideSharePermissions]
FLAGS
-e, --expand=<value>
(required) Use expand to include additional information about filter in the response.
Options:
•sharedUsers (Returns the users that the filter is shared with.)
•subscriptions (Returns the users that are subscribed to the filter.)
NOTE:
•Return values are limited to 1000, to access additional data use subscriptions[startIndex:endIndex] or
sharedUsers[startIndex:endIndex]
-i, --id=<value>
(required) Filter's ID.
--overrideSharePermissions
Whether share permissions are overridden to enable filters with any share permissions to be returned.
DESCRIPTION
Get more details about filter.
jira filter get-favourites
Get favourite filters.
USAGE
$ jira filter get-favourites [-e <value>]
FLAGS
-e, --expand=<value>
Use expand to include additional information about filter in the response.
Options:
•sharedUsers (Returns the users that the filter is shared with.)
•subscriptions (Returns the users that are subscribed to the filter.)
NOTE:
•Return values are limited to 1000, to access additional data use subscriptions[startIndex:endIndex] or
sharedUsers[startIndex:endIndex]
DESCRIPTION
Get favourite filters.
jira filter get-my
Get your filters.
USAGE
$ jira filter get-my [-e <value>] [--includeFavourites]
FLAGS
-e, --expand=<value>
Use expand to include additional information about filter in the response.
Options:
•sharedUsers (Returns the users that the filter is shared with.)
•subscriptions (Returns the users that are subscribed to the filter.)
NOTE:
•Return values are limited to 1000, to access additional data use subscriptions[startIndex:endIndex] or
sharedUsers[startIndex:endIndex]
--includeFavourites
Include the user's favorite filters in the response.
DESCRIPTION
Get your filters.
jira filter remove-favourite
Remove filter from your favourites.
USAGE
$ jira filter remove-favourite -i <value>
FLAGS
-i, --filterId=<value> (required) Filter's ID.
DESCRIPTION
Remove filter from your favourites.
jira filter reset-columns
Reset Filter's columns.
USAGE
$ jira filter reset-columns -i <value>
FLAGS
-i, --id=<value> (required) Filter's ID.
DESCRIPTION
Reset Filter's columns.
jira filter search
Search for filters.
USAGE
$ jira filter search [--startAt <value>] [--maxResults <value>] [--orderBy
description|favourite_count|id|is_favourite|name|owner|is_shared] [--orderDirection ASC|DSC] [--query <value>] [-u
<value>] [-g <value>] [-p <value>] [-i <value>] [-e description|favourite|favouritedCount,|jql|owner|searchUrl|share
Permissions|editPermissions|isWritable|subscriptions|viewUrl] [--overrideSharePermissions]
FLAGS
-e, --expand=<option>... Use expand to include additional information about filter in the response.
<options: description|favourite|favouritedCount,|jql|owner|searchUrl|sharePermissions|edit
Permissions|isWritable|subscriptions|viewUrl>
-g, --group=<value> The name or id of the group that you want to add users to.
-i, --id=<value>... The list of filter IDs
-p, --project=<value> Project ID or key that filters are shared with.
-u, --user=<value> Owner's account ID or username or email.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: description|favourite_count|id|is_favourite|name|owner|is_shared>
--orderDirection=<option> <options: ASC|DSC>
--overrideSharePermissions Whether share permissions are overridden to enable filters with any share permissions to
be returned
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Search for filters.
jira filter set-columns
Set Filter's columns.
USAGE
$ jira filter set-columns -i <value> -c <value>
FLAGS
-c, --columnKey=<value>... (required) The key of column. You can repeat this flag for setting multiple columns.
-i, --id=<value> (required) Filter's ID.
DESCRIPTION
Set Filter's columns.
jira filter update
Update a filter.
USAGE
$ jira filter update -i <value> [-n <value>] [-d <value>] [--jql <value>] [--favourite] [--editable]
FLAGS
-d, --description=<value> A description of the filter.
-i, --id=<value> (required) Filter ID
-n, --name=<value> Filter's name.
--[no-]editable Whether the filter is editable or not.
--favourite Whether the filter is editable or not.
--jql=<value> The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
DESCRIPTION
Update a filter.
jira group-and-user-picker find-groups [QUERY]
Returns a list of users matching a string.
USAGE
$ jira group-and-user-picker find-groups [QUERY] [--query <value>] [--maxResults <value>] [--fieldId <value>] [-p <value>]
[--issueTypeId <value>] [--caseSensitive] [--excludeConnectAddons]
ARGUMENTS
QUERY Find groups with query.
FLAGS
-p, --project=<value>... Project Ids or keys
--caseSensitive Whether the search for groups should be case insensitive.
--excludeConnectAddons Whether Connect app users and groups should be excluded from the search results.
--fieldId=<value> The custom field ID of the field this request is for.
--issueTypeId=<value>... The ID of an issue type that returned users and groups must have permission to view.
--maxResults=<value> The maximum number of items to return in each list.
--query=<value> The search string.
DESCRIPTION
Returns a list of users matching a string.
jira group-and-user-picker find-users [QUERY]
Returns a list of users matching a string.
USAGE
$ jira group-and-user-picker find-users [QUERY] --query <value> [--maxResults <value>] [--showAvatar] [-p <value>] [--issueTypeId
<value>] [--avatarSize xsmall|xsmall@2x|xsmall@3x|small|small@2x|small@3x|medium|medium@2x|medium@3x|large|large@2x|
large@3x|xlarge|xlarge@2x|xlarge@3x|xxlarge|xxlarge@2x|xxlarge@3x|xxxlarge|xxxlarge@2x|xxxlarge@3x]
[--caseSensitive] [--excludeConnectAddons]
ARGUMENTS
QUERY find user query
FLAGS
-p, --project=<value>... Project Id or key
--avatarSize=<option> [default: xsmall] The size of the avatar to return.
<options: xsmall|xsmall@2x|xsmall@3x|small|small@2x|small@3x|medium|medium@2x|medium@3x|larg
e|large@2x|large@3x|xlarge|xlarge@2x|xlarge@3x|xxlarge|xxlarge@2x|xxlarge@3x|xxxlarge|xxxlar
ge@2x|xxxlarge@3x>
--caseSensitive Whether the search for groups should be case insensitive.
--excludeConnectAddons Whether Connect app users and groups should be excluded from the search results.
--issueTypeId=<value>... The ID of an issue type that returned users and groups must have permission to view.
--maxResults=<value> The maximum number of items to return in each list.
--query=<value> (required) The search string.
--showAvatar Whether the user avatar should be returned.
DESCRIPTION
Returns a list of users matching a string.
jira group add-user [USER] [GROUP]
Adds a user to group.
USAGE
$ jira group add-user [USER] [GROUP] [--group <value>] [--name <value>] [-u <value>]
ARGUMENTS
USER The account ID or email or name of the user.
GROUP The name of the group that you want to remove users from.
FLAGS
-u, --user=<value> The account ID or username or email of the user
--group=<value> The name or id of the group that you want to add users to.
--name=<value> Name of the user.
DESCRIPTION
Adds a user to group.
jira group create [NAME]
Creates a group.
USAGE
$ jira group create [NAME] [-n <value>]
ARGUMENTS
NAME Group name you want to create.
FLAGS
-n, --name=<value> Group name you want to create.
DESCRIPTION
Creates a group.
jira group find-groups
Find Groups.
USAGE
$ jira group find-groups [-q <value>] [-m <value>] [-e <value>] [--excludeId <value>]
FLAGS
-e, --exclude=<value>... Group names that you want to exclude in the result.
-m, --maxResults=<value> The maximum number of groups to return.
-q, --query=<value> The string to find in group names.
--excludeId=<value>... Group IDs to exclude from the result
DESCRIPTION
Find Groups.
jira group get [GROUP]
Gets a group.
USAGE
$ jira group get [GROUP] [-g <value>]
ARGUMENTS
GROUP Group's name or id that you want to get.
FLAGS
-g, --group=<value>... Group's name or id that you want to get.
DESCRIPTION
Gets a group.
jira group get-all
Gets groups.
USAGE
$ jira group get-all [--applicationKey jira-servicedesk|jira-software|jira-product-discovery|jira-core]
[--acccesType site-admin|admin|user] [--all | --startAt <value> | --maxResults <value>]
FLAGS
--acccesType=<option> The access level of a group.
<options: site-admin|admin|user>
--all Whether all responses are returned.
--applicationKey=<option> The application key of the product user groups to search for.
<options: jira-servicedesk|jira-software|jira-product-discovery|jira-core>
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets groups.
jira group get-users [GROUP]
Gets users from a group.
USAGE
$ jira group get-users [GROUP] [-g <value>] [--includeInactiveUsers] [--all | --startAt <value> | --maxResults
<value>]
ARGUMENTS
GROUP Group's name that you want to get.
FLAGS
-g, --group=<value> The name or id of the group that you want to add users to.
--all Whether all responses are returned.
--includeInactiveUsers Include inactive users. (Default: false)
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets users from a group.
jira group remove [GROUP]
Removes a group.
USAGE
$ jira group remove [GROUP] [-g <value>] [--swapGroup <value>] [--swapGroupId <value>]
ARGUMENTS
GROUP Group Id or name.
FLAGS
-g, --group=<value> Group Id or name.
--swapGroup=<value> Group Name that you want to transfer deleted group's worklogs and comments to.
--swapGroupId=<value> Group Id that you want to transfer deleted group's worklogs and comments to. (Recommended)
DESCRIPTION
Removes a group.
jira group remove-user [USER] [GROUP]
Removes user from a group.
USAGE
$ jira group remove-user [USER] [GROUP] [--group <value>] [--name <value>] [-u <value>]
ARGUMENTS
USER The account ID or email or username of the user.
GROUP The name of the group that you want to remove users from.
FLAGS
-u, --user=<value> The account ID or email or username of the user
--group=<value> The name or id of the group that you want to add users to.
--name=<value> Name of the user.
DESCRIPTION
Removes user from a group.
jira help [COMMANDS]
Display help for jira.
USAGE
$ jira help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for jira.
See code: @oclif/plugin-help
jira issue-field-configuration assign-issue-type
Assigns issue types to field configurations on field configuration scheme.
USAGE
$ jira issue-field-configuration assign-issue-type --issueTypeId <value> --schemeId <value> --fieldConfigurationId
<value>
FLAGS
--fieldConfigurationId=<value> (required) The ID of the field configuration.
--issueTypeId=<value> (required) The ID of the issue type or default. When set to default this field
configuration issue type item applies to all issue types without a field
configuration.
--schemeId=<value> (required) The ID of the field configuration scheme.
DESCRIPTION
Assigns issue types to field configurations on field configuration scheme.
jira issue-field-configuration assign-scheme-to-project
Assings field configuration scheme to a project.
USAGE
$ jira issue-field-configuration assign-scheme-to-project -p <value> [--fieldConfigurationSchemeId <value>]
FLAGS
-p, --project=<value> (required) Project Id or key.
--fieldConfigurationSchemeId=<value> The ID of the field configuration scheme. If the field configuration scheme ID
is null, the operation assigns the default field configuration scheme.
DESCRIPTION
Assings field configuration scheme to a project.
jira issue-field-configuration create
Creates an issue field configuration.
USAGE
$ jira issue-field-configuration create -n <value> [--description <value>]
FLAGS
-n, --name=<value> (required) The name of the field configuration. Must be unique.
--description=<value> The description of the field configuration.
DESCRIPTION
Creates an issue field configuration.
jira issue-field-configuration create-scheme
Creates a field configuration scheme.
USAGE
$ jira issue-field-configuration create-scheme -n <value> [--description <value>]
FLAGS
-n, --name=<value> (required) The name of the field configuration. Must be unique.
--description=<value> The description of the field configuration scheme.
DESCRIPTION
Creates a field configuration scheme.
jira issue-field-configuration delete
Deletes an issue field configuration.
USAGE
$ jira issue-field-configuration delete -i <value>
FLAGS
-i, --id=<value> (required) The ID of the field configuration.
DESCRIPTION
Deletes an issue field configuration.
jira issue-field-configuration delete-scheme
Deletes an issue field configuration scheme.
USAGE
$ jira issue-field-configuration delete-scheme -i <value>
FLAGS
-i, --schemeId=<value> (required) The ID of the field configuration scheme.
DESCRIPTION
Deletes an issue field configuration scheme.
jira issue-field-configuration get-all
Gets all issue field configurations.
USAGE
$ jira issue-field-configuration get-all [-i <value>] [-q <value>] [--isDefault] [--all | --startAt <value> |
--maxResults <value>]
FLAGS
-i, --id=<value>... The list of field configuration IDs. You can provide multiple IDs.
-q, --query=<value> The query string used to match against field configuration names and descriptions.
--all Whether all responses are returned.
--isDefault If true returns default field configurations only.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all issue field configurations.
jira issue-field-configuration get-all-issue-type-items
Gets all field configuration issue type items.
USAGE
$ jira issue-field-configuration get-all-issue-type-items [-i <value>] [--all | --startAt <value> | --maxResults
<value>]
FLAGS
-i, --fieldConfigurationSchemeId=<value>... The list of field configuration scheme IDs.
--all Whether all responses are returned.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all field configuration issue type items.
jira issue-field-configuration get-all-schemes
Gets all field configuration schemes.
USAGE
$ jira issue-field-configuration get-all-schemes [-i <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value>... The list of field configuration IDs. You can provide multiple IDs.
--all Whether all responses are returned.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all field configuration schemes.
jira issue-field-configuration get-items
Gets all fields for a configuration.
USAGE
$ jira issue-field-configuration get-items [-i <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value>... The list of field configuration IDs. You can provide multiple IDs.
--all Whether all responses are returned.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all fields for a configuration.
jira issue-field-configuration get-project-schemes
Gets field configuration schemes and, for each scheme, a list of the projects that use it.
USAGE
$ jira issue-field-configuration get-project-schemes [-p <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-p, --project=<value>... The list of project Ids or keys. You can provide multiple IDs or keys.
--all Whether all responses are returned.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets field configuration schemes and, for each scheme, a list of the projects that use it.
jira issue-field-configuration remove-issue-types
Removes issue types from field configurations on field configuration scheme.
USAGE
$ jira issue-field-configuration remove-issue-types --issueTypeIds <value> --schemeId <value>
FLAGS
--issueTypeIds=<value>... (required) The list of issue type IDs. Must contain unique values not longer than 255
characters and not be empty. Maximum of 100 IDs.
--schemeId=<value> (required) The ID of the field configuration scheme.
DESCRIPTION
Removes issue types from field configurations on field configuration scheme.
jira issue-field-configuration update
Updates an issue field configurations.
USAGE
$ jira issue-field-configuration update -i <value> [-n <value>] [--description <value>]
FLAGS
-i, --id=<value> (required) The ID of the field configuration.
-n, --name=<value> The name of the field configuration. Must be unique.
--description=<value> The description of the field configuration.
DESCRIPTION
Updates an issue field configurations.
jira issue-field-configuration update-items
Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.
USAGE
$ jira issue-field-configuration update-items -i <value> --fieldID <value> [--isHidden] [--isRequired] [--description <value>] [--renderer
<value>]
FLAGS
-i, --configID=<value> (required) The ID of the field configuration.
--description=<value> The description of the field configuration.
--fieldID=<value> (required) The ID of the issue field.
--isHidden Whether the field is hidden in the field configuration.
--isRequired Whether the field is required in the field configuration.
--renderer=<value> The renderer type for the field within the field configuration.
DESCRIPTION
Updates fields in a field configuration. The properties of the field configuration fields provided override the
existing values.
jira issue-field-configuration update-scheme
Updates a field configuration scheme.
USAGE
$ jira issue-field-configuration update-scheme -i <value> [-n <value>] [--description <value>]
FLAGS
-i, --schemeId=<value> (required) The ID of the field configuration scheme.
-n, --name=<value> The name of the field configuration. Must be unique.
--description=<value> The description of the field configuration scheme.
DESCRIPTION
Updates a field configuration scheme.
jira issue-field-context add-issue-types
Adds issue types to a custom field context, appending the issue types to the issue types list.
USAGE
$ jira issue-field-context add-issue-types --fieldId <value> --contextId <value> --issueTypeIds <value>
FLAGS
--contextId=<value> (required) TThe ID of the context.
--fieldId=<value> (required) The ID of the custom field.
--issueTypeIds=<value>... (required) The list of issue type IDs.
DESCRIPTION
Adds issue types to a custom field context, appending the issue types to the issue types list.
jira issue-field-context assign-to-projects
Assigns a custom field context to projects.
USAGE
$ jira issue-field-context assign-to-projects --fieldId <value> --contextId <value> --project <value>
FLAGS
--contextId=<value> (required) The ID of the context.
--fieldId=<value> (required) The ID of the custom field.
--project=<value>... (required) The list of project IDs or keys.
DESCRIPTION
Assigns a custom field context to projects.
jira issue-field-context create
Creates an issue field context. If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types.
USAGE
$ jira issue-field-context create -i <value> -n <value> [--description <value>] [-p <value>] [--issueTypeIds <value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the custom field.
-n, --name=<value> (required) The name of the field context. Must be unique.
-p, --project=<value>... The list of project IDs or keys associated with the context. If the list is empty, the
context is global.
--description=<value> The description of the field context.
--issueTypeIds=<value>... The list of issue types IDs for the context. If the list is empty, the context refers to
all issue types.
DESCRIPTION
Creates an issue field context. If projectIds is empty, a global context is created. A global context is one that
applies to all project. If issueTypeIds is empty, the context applies to all issue types.
jira issue-field-context delete
Deletes an issue field context.
USAGE
$ jira issue-field-context delete --fieldId <value> --contextId <value>
FLAGS
--contextId=<value> (required) The ID of the context.
--fieldId=<value> (required) The ID of the custom field.
DESCRIPTION
Deletes an issue field context.
jira issue-field-context get-all
Gets all issue field contexts.
USAGE
$ jira issue-field-context get-all -i <value> [--contextId <value>] [--isAnyIssueType] [--isGlobalContext] [--all | --startAt
<value> | --maxResults <value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the custom field.
--all Whether all responses are returned.
--contextId=<value>... The list of context IDs. You can provide multiple IDs.
--isAnyIssueType Whether to return contexts that apply to all issue types.
--isGlobalContext Whether to return contexts that apply to all projects.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all issue field contexts.
jira issue-field-context get-contexts-for-projects-and-issue-types
Gets project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type.
USAGE
$ jira issue-field-context get-contexts-for-projects-and-issue-types -i <value> --mappings <value> [--startAt <value>]
[--maxResults <value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the custom field.
--mappings=<value>... (required) The project and issue type mappings. Example use case:
--mappings=projectId=10000,issueTypeId=10000
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the
project and issue type.
jira issue-field-context get-default-values
Gets defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
USAGE
$ jira issue-field-context get-default-values -i <value> [--contextId <value>] [--all | --startAt <value> |
--maxResults <value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the custom field.
--all Whether all responses are returned.
--contextId=<value>... The list of context IDs. You can provide multiple IDs.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no
defaults are set for a context, nothing is returned.
jira issue-field-context get-issue-types
Gets list of context to issue type mappings for a custom field. The result can be filtered by contextId
USAGE
$ jira issue-field-context get-issue-types -i <value> [--contextId <value>] [--all | --startAt <value> | --maxResults
<value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the custom field.
--all Whether all responses are returned.
--contextId=<value>... The list of context IDs. You can provide multiple IDs.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets list of context to issue type mappings for a custom field. The result can be filtered by contextId
jira issue-field-context get-project-mappings
Gets list of context to project mappings for a custom field. The result can be filtered by contextId
USAGE
$ jira issue-field-context get-project-mappings -i <value> [--contextId <value>] [--all | --startAt <value> |
--maxResults <value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the custom field.
--all Whether all responses are returned.
--contextId=<value>... The list of context IDs. You can provide multiple IDs.
--maxResults=<value> The maximum number of groups to return.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets list of context to project mappings for a custom field. The result can be filtered by contextId
jira issue-field-context remove-from-projects
Removes a custom field context from projects.
USAGE
$ jira issue-field-context remove-from-projects --fieldId <value> --contextId <value> -p <value>
FLAGS
-p, --project=<value>... (required) The list of project IDs or keys.
--contextId=<value> (required) The ID of the context.
--fieldId=<value> (required) The ID of the custom field.
DESCRIPTION
Removes a custom field context from projects.
jira issue-field-context remove-issue-types
Removes issue types from a custom field context. A custom field context without any issue types applies to all issue types
USAGE
$ jira issue-field-context remove-issue-types --fieldId <value> --contextId <value> --issueTypeIds <value>
FLAGS
--contextId=<value> (required) The ID of the context.
--fieldId=<value> (required) The ID of the custom field.
--issueTypeIds=<value>... (required) The list of issue type IDs.
DESCRIPTION
Removes issue types from a custom field context. A custom field context without any issue types applies to all issue
types
jira issue-field-context set-default-values
Sets default for contexts of a custom field.
USAGE
$ jira issue-field-context set-default-values -i <value> [--defaultValues <value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the custom field.
--defaultValues=<value>... Default values to update. (Note: Please provide json object to this flag. For available
defaultValues: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue
-custom-field-contexts/#api-rest-api-3-field-fieldid-context-defaultvalue-put)
Avalible Json value should be like: "{'type': 'grouppciker.single', 'contextId': '10000'}"
(Keys and values should be written in single quotes.)
DESCRIPTION
Sets default for contexts of a custom field.
jira issue-field-context update
Updates an issue field context.
USAGE
$ jira issue-field-context update --fieldId <value> --contextId <value> -n <value> [--description <value>]
FLAGS
-n, --name=<value> (required) The name of the field context. Must be unique.
--contextId=<value> (required) The ID of the context.
--description=<value> The description of the field context.
--fieldId=<value> (required) The ID of the custom field.
DESCRIPTION
Updates an issue field context.
jira issue-field-option create-for-context
Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field.
USAGE
$ jira issue-field-option create-for-context --fieldId <value> --contextId <value> [--options <value>]
FLAGS
--contextId=<value> (required) The ID of the context.
--fieldId=<value> (required) The ID of the custom field.
--options=<value>... Details of options to create. You can use this flag multiple times to add more option. Example
use case: --options:value=optionValue,optionId=1000,disabled=true
DESCRIPTION
Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a
custom select field. The options are added to a context of the field.
jira issue-field-option delete-for-context
Deletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first.
USAGE
$ jira issue-field-option delete-for-context --fieldId <value> --contextId <value> --optionId <value>
FLAGS
--contextId=<value> (required) The ID of the context from which an option should be deleted.
--fieldId=<value> (required) The ID of the custom field.
--optionId=<value> (required) The ID of the option to delete.
DESCRIPTION
Deletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options
first.
jira issue-field-option get [OPTIONID]
Gets custom field option.
USAGE
$ jira issue-field-option get [OPTIONID] [-i <value>]
ARGUMENTS
OPTIONID The ID of the custom field option.
FLAGS
-i, --optionId=<value>... The ID of the custom field option.
DESCRIPTION
Gets custom field option.
jira issue-field-option get-for-context
Gets all custom field option for a context.
USAGE
$ jira issue-field-option get-for-context --fieldId <value> --contextId <value> [--optionId <value>] [--onlyOptions] [--all |
--startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--contextId=<value> (required) The ID of the context.
--fieldId=<value> (required) The ID of the custom field.
--maxResults=<value> The maximum number of items to return per page.
--onlyOptions Whether only options are returned.
--optionId=<value> The ID of the option.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all custom field option for a context.
jira issue-field-option reorder-for-context
Changes the order of custom field options or cascading options in a context.
USAGE
$ jira issue-field-option reorder-for-context --fieldId <value> --contextId <value> --customFieldOptionId <value> [--after <value>
--position First|Last]
FLAGS
--after=<value> The ID of the custom field option or cascading option to place the moved options
after. Required if position isn't provided.
--contextId=<value> (required) The ID of the context.
--customFieldOptionId=<value>... (required) ID of custom field options to move. You can provide multiple ID by
repeating this flag. The order of the custom field option IDs in the list is the
order they are given after the move. The list must contain custom field options or
cascading options, but not both.
--fieldId=<value> (required) The ID of the custom field.
--position=<option> The position the custom field options should be moved to. Required if after isn't
provided.
<options: First|Last>
DESCRIPTION
Changes the order of custom field options or cascading options in a context.
jira issue-field-option update-for-context
Updates the options of a custom field. If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response.
USAGE
$ jira issue-field-option update-for-context --fieldId <value> --contextId <value> [--options <value>]
FLAGS
--contextId=<value> (required) The ID of the context.
--fieldId=<value> (required) The ID of the custom field.
--options=<value>... Details of options to create. You can use this flag multiple times to add more option. Example
use case: --options:value=optionValue,id=1000,disabled=true
DESCRIPTION
Updates the options of a custom field. If any of the options are not found, no options are updated. Options where the
values in the request match the current values aren't updated and aren't reported in the response.
jira issue-field create
Creates a custom field.
USAGE
$ jira issue-field create --name <value> --type <value> [--searcher <value>] [--description <value>]
FLAGS
--description=<value> The description of the custom field, which is displayed in Jira.
--name=<value> (required) The name of the custom field, which is displayed in Jira. This is not the unique
identifier.
--searcher=<value> The searcher defines the way the field is searched in Jira. Get more details:
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-ap
i-3-field-post
--type=<value> (required) The type of the custom field.
DESCRIPTION
Creates a custom field.
jira issue-field delete
Deletes issue field. CLOUD ONLY -> This operation is asynchronous. You can use jira task:get
command to obtain any updates.
USAGE
$ jira issue-field delete -i <value> [--silent]
FLAGS
-i, --id=<value>... (required) Field Id.
--silent If you activate this flag progress bar will not be shown.
DESCRIPTION
Deletes issue field. CLOUD ONLY -> This operation is asynchronous. You can use `jira task:get` command to obtain any
updates.
jira issue-field get-all
Returns system and custom issue fields.
USAGE
$ jira issue-field get-all
DESCRIPTION
Returns system and custom issue fields.
jira issue-field move-trash
Moves a issue field to trash.
USAGE
$ jira issue-field move-trash -i <value>
FLAGS
-i, --id=<value> (required) Field Id.
DESCRIPTION
Moves a issue field to trash.
jira issue-field restore-trash
Restores a issue field from trash.
USAGE
$ jira issue-field restore-trash -i <value>
FLAGS
-i, --id=<value> (required) Field Id.
DESCRIPTION
Restores a issue field from trash.
jira issue-field search
Searchs for custom fields. This command is only applicable to Jira Cloud
USAGE
$ jira issue-field search [-i <value>] [--type system|custom] [--orderBy name|contextsCount|lastUsed|screensCount]
[--orderDirection ASC|DSC] [--query <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value>... Field Id
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: name|contextsCount|lastUsed|screensCount>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
--type=<option>... Type of custom field
<options: system|custom>
DESCRIPTION
Searchs for custom fields. This command is only applicable to Jira Cloud
jira issue-field search-trash
Searchs for issue fields which are in the trash. This command is only applicable to Jira Cloud
USAGE
$ jira issue-field search-trash [--id <value>] [--orderBy name|trashedDate|plannedDeletionDate] [--orderDirection ASC|DSC]
[--query <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--id=<value>... Field Id
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: name|trashedDate|plannedDeletionDate>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Searchs for issue fields which are in the trash. This command is only applicable to Jira Cloud
jira issue-field update
Updates a custom field.
USAGE
$ jira issue-field update -i <value> [--name <value>] [--searcherKey <value>] [--description <value>]
FLAGS
-i, --id=<value> (required) Field Id.
--description=<value> The description of the custom field, which is displayed in Jira.
--name=<value> The name of the custom field, which is displayed in Jira. This is not the unique identifier.
--searcherKey=<value> The searcher defines the way the field is searched in Jira. Get more details:
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-ap
i-3-field-fieldid-put
DESCRIPTION
Updates a custom field.
jira issue-link-type create
Creates an issue link type.
USAGE
$ jira issue-link-type create -n <value> --inward <value> --outward <value>
FLAGS
-n, --name=<value> (required) The name of the issue link type. Required on create when id is not provided.
Otherwise, read only.
--inward=<value> (required) The description of the issue link type inward link.
--outward=<value> (required) The description of the issue link type outward link.
DESCRIPTION
Creates an issue link type.
jira issue-link-type delete
Deletes an issue link type.
USAGE
$ jira issue-link-type delete -i <value>
FLAGS
-i, --issueLinkTypeId=<value> (required) The ID of the issue link type.
DESCRIPTION
Deletes an issue link type.
jira issue-link-type get [ISSUELINKTYPEID]
Gets an issue link type.
USAGE
$ jira issue-link-type get [ISSUELINKTYPEID] [-i <value>]
ARGUMENTS
ISSUELINKTYPEID The ID of the issue link type.
FLAGS
-i, --issueLinkTypeId=<value>... The ID of the issue link type.
DESCRIPTION
Gets an issue link type.
jira issue-link-type get-all
Gets all issue link types.
USAGE
$ jira issue-link-type get-all
DESCRIPTION
Gets all issue link types.
jira issue-link-type update
Updates an issue link type.
USAGE
$ jira issue-link-type update -i <value> [-n <value>] [--inward <value>] [--outward <value>]
FLAGS
-i, --issueLinkTypeId=<value> (required) The ID of the issue link type.
-n, --name=<value> The name of the issue link type.
--inward=<value> The description of the issue link type inward link.
--outward=<value> The description of the issue link type outward link.
DESCRIPTION
Updates an issue link type.
jira issue-link create [ISSUELINKBODY]
Creates a link between two issues. You can also provide request body as JSON using STDIN without specifying any flags.
USAGE
$ jira issue-link create [ISSUELINKBODY] [--show] [--issueLinkTypeID <value>] [--issueLinkTypeName <value>]
[--inwardIssue <value>] [--outwardIssue <value>] [--commentVisibility <value> --comment <value>] [--commentProperty
<value> ]
ARGUMENTS
ISSUELINKBODY Issue Link creation request in JSON format.
FLAGS
--comment=<value> A comment.
--commentProperty=<value> A comment property. You can use this flag multiple times to provide more properties.
KEYS: [key, value]
Example usage: --commentProperty=key=XX,value=XXXX
--commentVisibility=<value> The group or role to which this comment is visible. KEYS: [type, identifier, value]
Example usage: --commentVisibility=type=group,value=jira-software-users
--inwardIssue=<value> The ID or key of a linked issue. KEYS: [id, key]
Example usage: --inwardIssue=key=HYP-1 or --inwardIssue=id=10000
--issueLinkTypeID=<value> The ID of the issue link type. Find a list of issue link types with 'jira
issue-link-type:get-all' command.
--issueLinkTypeName=<value> The name of the issue link type. Find a list of issue link types with 'jira
issue-link-type:get-all' command.
--outwardIssue=<value> The ID or key of a linked issue. KEYS: [id, key]
Example usage: --outwardIssue=key=HYP-1 or --outwardIssue=id=10000
--show Prepare a sample JSON output for issue link creation.
DESCRIPTION
Creates a link between two issues. You can also provide request body as JSON using STDIN without specifying any flags.
jira issue-link delete [LINKID]
Deletes an issue link.
USAGE
$ jira issue-link delete [LINKID] [-i <value>]
ARGUMENTS
LINKID The ID of the issue link.
FLAGS
-i, --linkId=<value> The ID of the issue link.
DESCRIPTION
Deletes an issue link.
jira issue-link get [LINKID]
Gets an issue link.
USAGE
$ jira issue-link get [LINKID] [-i <value>]
ARGUMENTS
LINKID The ID of the issue link.
FLAGS
-i, --linkId=<value>... The ID of the issue link.
DESCRIPTION
Gets an issue link.
jira issue-navigator-setting get-columns
Returns the default issue navigator columns.
USAGE
$ jira issue-navigator-setting get-columns
DESCRIPTION
Returns the default issue navigator columns.
jira issue-navigator-setting set-columns
Sets the default issue navigator columns.
USAGE
$ jira issue-navigator-setting set-columns -c <value>
FLAGS
-c, --columnKey=<value>... (required) The key of column. You can repeat this flag for setting multiple columns.
DESCRIPTION
Sets the default issue navigator columns.
jira issue-priority create
Creates an issue priority.
USAGE
$ jira issue-priority create -n <value> -i blocker|critical|high|highest|low|lowest|major|medium|minor|trivial -k <value>
[--description <value>]
FLAGS
-i, --icon=<option> (required) An icon for the priority.
<options: blocker|critical|high|highest|low|lowest|major|medium|minor|trivial>
-k, --statusColor=<value> (required) The status color of the priority in 3-digit or 6-digit hexadecimal format. For
example: -k="FFFF00"
-n, --name=<value> (required) The name of the priority. Must be unique.
--description=<value> The description of the priority.
DESCRIPTION
Creates an issue priority.
jira issue-priority delete
Deletes an issue priority.
USAGE
$ jira issue-priority delete -i <value> -r <value> [--silent]
FLAGS
-i, --id=<value> (required) The ID of the issue priority.
-r, --replaceWith=<value> (required) The ID of the issue priority that will replace the currently selected
resolution.
--silent If you activate this flag progress bar will not be shown.
DESCRIPTION
Deletes an issue priority.
jira issue-priority move
Changes the order of issue priorities.
USAGE
$ jira issue-priority move -i <value> [-a <value>] [-p <value>]
FLAGS
-a, --after=<value> The ID of the priority. Required if position isn't provided.
-i, --issues=<value> (required) The list of issue IDs to be reordered. Cannot contain duplicates nor after ID.
-p, --position=<value> The position for issue priorities to be moved to. Required if after isn't provided.
DESCRIPTION
Changes the order of issue priorities.
jira issue-priority search
Search issue-priorities.
USAGE
$ jira issue-priority search [-i <value>] [--onlyDefault] [--query <value>] [-p <value>] [--all | --startAt <value> |
--maxResults <value>]
FLAGS
-i, --id=<value> The list of priority IDs. To include multiple IDs, provide an comma-separated list. For
example, -i="2,3".
-p, --project=<value>... For server only. For example, -p = 10200
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--onlyDefault Only default priority returned, for cloud only
--query=<value> Whether only the default priority is returned.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Search issue-priorities.
jira issue-priority set-default
Sets default issue priority.
USAGE
$ jira issue-priority set-default [-i <value>]
FLAGS
-i, --id=<value> The ID of the new default issue priority. Must be an existing ID or null. Setting this to null
erases the default priority setting.
DESCRIPTION
Sets default issue priority.
jira issue-priority update
My description
USAGE
$ jira issue-priority update -i <value> --icon blocker|critical|high|highest|low|lowest|major|medium|minor|trivial [-n
<value>] [-d <value>] [-k <value>]
FLAGS
-d, --description=<value> The description of the priority.
-i, --id=<value> (required) The ID of the issue priority.
-k, --statusColor=<value> The status color of the priority in 3-digit or 6-digit hexadecimal format.
-n, --name=<value> The description of the priority.
--icon=<option> (required) An icon for the priority. Built in icons can also be used.
<options: blocker|critical|high|highest|low|lowest|major|medium|minor|trivial>
DESCRIPTION
My description
jira issue-property delete
Deletes an issue's property.
USAGE
$ jira issue-property delete --issue <value> --key <value>
FLAGS
--issue=<value> (required) The key or ID of the issue.
--key=<value> (required) The key of the property.
DESCRIPTION
Deletes an issue's property.
jira issue-property delete-bulk [JSONBODY]
Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. This operation is asynchronous. You can use jira task:get
command to obtain any updates.
USAGE
$ jira issue-property delete-bulk [JSONBODY] [--key <value>] [--show] [--silent]
ARGUMENTS
JSONBODY Bulk delete request in JSON format.
FLAGS
--key=<value> The key of the property. (Required)
--show Prepare a sample JSON output for command.
--silent If you activate this flag progress bar will not be shown and you won't wait for the process. If you
want to get details about task you can simply call `jira task:get` command.
DESCRIPTION
Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. This
operation is asynchronous. You can use `jira task:get` command to obtain any updates.
jira issue-property get
Gets the key and value of an issue's property.
USAGE
$ jira issue-property get --issue <value> --key <value>
FLAGS
--issue=<value> (required) The key or ID of the issue.
--key=<value> (required) The key of the property.
DESCRIPTION
Gets the key and value of an issue's property.
jira issue-property get-keys
Gets the URLs and keys of an issue's properties. This operation can be accessed anonymously.
USAGE
$ jira issue-property get-keys --issue <value>
FLAGS
--issue=<value> (required) The key or ID of the issue.
DESCRIPTION
Gets the URLs and keys of an issue's properties. This operation can be accessed anonymously.
jira issue-property set [JSONBODY]
Sets the value of an issue's property. Use this resource to store custom data against an issue. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
USAGE
$ jira issue-property set [JSONBODY] --issue <value> --key <value>
ARGUMENTS
JSONBODY Issue property set request in JSON format.
FLAGS
--issue=<value> (required) The key or ID of the issue.
--key=<value> (required) The key of the property.
DESCRIPTION
Sets the value of an issue's property. Use this resource to store custom data against an issue. The value of the
request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
jira issue-property set-bulk [JSONBODY]
Sets a property value on multiple issues. This operation is asynchronous. You can use jira task:get
command to obtain any updates.
USAGE
$ jira issue-property set-bulk [JSONBODY] [--key <value>] [--show] [--silent]
ARGUMENTS
JSONBODY Bulk set request in JSON format.
FLAGS
--key=<value> The key of the property. (Required)
--show Prepare a sample JSON output for command.
--silent If you activate this flag progress bar will not be shown and you won't wait for the process. If you
want to get details about task you can simply call `jira task:get` command.
DESCRIPTION
Sets a property value on multiple issues. This operation is asynchronous. You can use `jira task:get` command to
obtain any updates.
jira issue-property set-by-issue-bulk [JSONBODY]
Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up to 100 issues included in the request. This operation is asynchronous. You can use jira task:get
command to obtain any updates.
USAGE
$ jira issue-property set-by-issue-bulk [JSONBODY] [--show] [--silent]
ARGUMENTS
JSONBODY Bulk set issue properties by issue request in JSON format.
FLAGS
--show Prepare a sample JSON output for command.
--silent If you activate this flag progress bar will not be shown and you won't wait for the process. If you want to
get details about task you can simply call `jira task:get` command.
DESCRIPTION
Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up to
100 issues included in the request. This operation is asynchronous. You can use `jira task:get` command to obtain any
updates.
jira issue-property set-by-list-bulk [JSONBODY]
Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified along with up to 10,000 issues on which to set or update that list of entity properties. This operation is asynchronous. You can use jira task:get
command to obtain any updates.
USAGE
$ jira issue-property set-by-list-bulk [JSONBODY] [--show] [--silent]
ARGUMENTS
JSONBODY Bulk set issue properties by list request in JSON format.
FLAGS
--show Prepare a sample JSON output for command.
--silent If you activate this flag progress bar will not be shown and you will not wait for the process. If you want
to get details about task you can simply call `jira task:get` command.
DESCRIPTION
Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified
along with up to 10,000 issues on which to set or update that list of entity properties. This operation is
asynchronous. You can use `jira task:get` command to obtain any updates.
jira issue-remote-link create [ISSUEREMOTELINKBODY]
Creates or updates a remote issue link for an issue. You must provide request body as JSON using STDIN.
USAGE
$ jira issue-remote-link create [ISSUEREMOTELINKBODY] [-i <value>] [--show]
ARGUMENTS
ISSUEREMOTELINKBODY Issue remote link creation request body in JSON format.
FLAGS
-i, --issue=<value> Issue ID or Key.
--show Prepare a sample JSON output for issue remote link creation.
DESCRIPTION
Creates or updates a remote issue link for an issue. You must provide request body as JSON using STDIN.
NOTE: If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without
values in the request are set to null. Otherwise, the remote issue link is created.
jira issue-remote-link delete
Deletes a remote issue link from an issue.
USAGE
$ jira issue-remote-link delete -i <value> --linkId <value>
FLAGS
-i, --issue=<value> (required) Issue ID or Key.
--linkId=<value> (required) The ID of the remote issue link.
DESCRIPTION
Deletes a remote issue link from an issue.
jira issue-remote-link delete-by-global-id
Deletes the remote issue link from the issue using the link's global ID.
USAGE
$ jira issue-remote-link delete-by-global-id -i <value> --globalId <value>
FLAGS
-i, --issue=<value> (required) Issue ID or Key.
--globalId=<value> (required) The global ID of the remote issue link.
DESCRIPTION
Deletes the remote issue link from the issue using the link's global ID.
jira issue-remote-link get
Returns a remote issue link for an issue.
USAGE
$ jira issue-remote-link get -i <value> --linkId <value>
FLAGS
-i, --issue=<value> (required) Issue ID or Key.
--linkId=<value> (required) The ID of the remote issue link.
DESCRIPTION
Returns a remote issue link for an issue.
jira issue-remote-link get-all
Returns the remote issue links for an issue.
USAGE
$ jira issue-remote-link get-all [-i <value>] [--globalId <value>]
FLAGS
-i, --issue=<value> Issue ID or Key.
--globalId=<value> The global ID of the remote issue link.
DESCRIPTION
Returns the remote issue links for an issue.
NOTE: When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote
issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For
example, pass system=http://www.mycompany.com/support&id=1 as
system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.
jira issue-remote-link update [ISSUEREMOTELINKBODY]
Updates a remote issue link for an issue.
USAGE
$ jira issue-remote-link update [ISSUEREMOTELINKBODY] [-i <value>] [--show] [--linkId <value>]
ARGUMENTS
ISSUEREMOTELINKBODY Issue remote link update request body in JSON format.
FLAGS
-i, --issue=<value> Issue ID or Key.
--linkId=<value> The ID of the remote issue link.
--show Prepare a sample JSON output for issue remote link creation.
DESCRIPTION
Updates a remote issue link for an issue.
jira issue-resolution create
Creates an issue resolution. Only for cloud
USAGE
$ jira issue-resolution create -n <value> [--description <value>]
FLAGS
-n, --name=<value> (required) The name of the resolution. Must be unique (case-insensitive).
--description=<value> The description of the resolution.
DESCRIPTION
Creates an issue resolution. Only for cloud
jira issue-resolution delete
Deletes an issue resolution.
USAGE
$ jira issue-resolution delete -i <value> -r <value> [--silent]
FLAGS
-i, --id=<value> (required) The ID of the issue resolution.
-r, --replaceWith=<value> (required) The ID of the issue resolution that will replace the currently selected
resolution.
--silent If you activate this flag progress bar will not be shown.
DESCRIPTION
Deletes an issue resolution.
jira issue-resolution get [ID]
Returns a resolution. Only for server
USAGE
$ jira issue-resolution get [ID] [-i <value>]
ARGUMENTS
ID Id of issue-resolution.
FLAGS
-i, --id=<value>... Id of issue-resolution.
DESCRIPTION
Returns a resolution. Only for server
jira issue-resolution get-all
Returns a list of all resolutions. Only for server.
USAGE
$ jira issue-resolution get-all
DESCRIPTION
Returns a list of all resolutions. Only for server.
jira issue-resolution move
Changes the order of issue resolutions.
USAGE
$ jira issue-resolution move -i <value> [-a <value>] [-p <value>]
FLAGS
-a, --after=<value> The ID of the resolution. Required if position isn't provided
-i, --ids=<value> (required) The list of resolution IDs to be reordered. Cannot contain duplicates nor after ID.
Example usage: --id=1,2,3
-p, --position=<value> The position for issue resolutions to be moved to. Required if after isn't provided.
DESCRIPTION
Changes the order of issue resolutions.
jira issue-resolution search
Returns a paginated list of resolutions.
USAGE
$ jira issue-resolution search [-i <value>] [--onlyDefault] [-q <value>] [--all | | ]
FLAGS
-i, --id=<value> The list of resolutions IDs to be filtered out.Example usage: --id=1,2,3
-q, --query=<value> The string that status names will be matched with
--all Whether all responses are returned.
--onlyDefault When set to true, return default only,when IDs provided, if none of them is default, return empty
page.
DESCRIPTION
Returns a paginated list of resolutions.
jira issue-resolution set-default
Sets default issue resolution. Only for cloud
USAGE
$ jira issue-resolution set-default -i <value>
FLAGS
-i, --id=<value> (required) The ID of the new default issue resolution. Must be an existing ID or null. Setting this
to null erases the default resolution setting.
DESCRIPTION
Sets default issue resolution. Only for cloud
jira issue-resolution update
Updates an issue resolution.
USAGE
$ jira issue-resolution update -i <value> -n <value> [--description <value>]
FLAGS
-i, --id=<value> (required) The ID of the issue resolution.
-n, --name=<value> (required) Updates an issue resolution.
--description=<value> The description of the resolution.
DESCRIPTION
Updates an issue resolution.
jira issue-search get-picker-suggestions
Gets the issues matching a query string. This command returns two types of search:
USAGE
$ jira issue-search get-picker-suggestions [-q <value>] [-j <value>] [-i <value>] [-p <value>] [--showSubTasks]
[--showSubTaskParent]
FLAGS
-i, --issue=<value> The key of an issue to exclude from search results. For example, the issue the user is viewing
when they perform this query.
-j, --jql=<value> A JQL query defining a list of issues to search for the query term. Note that username and
userkey cannot be used as search terms for this parameter, due to privacy reasons. Use
accountId instead.
-p, --project=<value> The ID or key of a project that suggested issues must belong to.
-q, --query=<value> A string to match against text fields in the issue such as title, description, or comments.
--showSubTaskParent When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it
matches the query.
--showSubTasks Indicate whether to include subtasks in the suggestions list.
DESCRIPTION
Gets the issues matching a query string. This command returns two types of search:
- History Search which includes issues from the user's history of created, edited, or viewed issues that contain the
string in the query parameter.
- Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query
parameter.
jira issue-search search
Searches for issues using JQL.
USAGE
$ jira issue-search search [-j <value>] [-v strict|warn|none|true|false] [--all | --startAt <value> | --maxResults
<value>]
FLAGS
-j, --jql=<value> A JQL expression.
-v, --validateQuery=<option> Determines how to validate the JQL query and treat the validation results.
<options: strict|warn|none|true|false>
--all Whether all of found issues are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Searches for issues using JQL.
jira issue-search test-jql
Checks whether one or more issues would be returned by one or more JQL queries.
USAGE
$ jira issue-search test-jql -j <value> -i <value>
FLAGS
-i, --issue=<value>... (required) The ID of issue. You can provide multiple jql query by repeating this flag.
-j, --jql=<value>... (required) JQL query. You can provide multiple jql query by repeating this flag.
DESCRIPTION
Checks whether one or more issues would be returned by one or more JQL queries.
jira issue-security-level get [ISSUESECURITYLEVELID]
Returns details of an issue security level.
USAGE
$ jira issue-security-level get [ISSUESECURITYLEVELID] [-i <value>]
ARGUMENTS
ISSUESECURITYLEVELID The ID of issue security level.
FLAGS
-i, --id=<value>... The ID of issue security level.
DESCRIPTION
Returns details of an issue security level.
jira issue-security-level get-members
Returns issue security level members.
USAGE
$ jira issue-security-level get-members -i <value> [-l <value>] [-e all|field|group|projectRole|user] [--all | | ]
FLAGS
-e, --expand=<option> Use expand to include additional information in the response. This parameter
accepts a comma-separated list.
<options: all|field|group|projectRole|user>
-i, --issueSecuritySchemeId=<value> (required) The ID of the issue security scheme. Use the Get issue security
schemes operation to get a list of issue security scheme IDs.
-l, --issueSecurityLevelId=<value> The list of issue security level IDs. To include multiple issue security levels
separate IDs with comma: -i=10000,10001
--all Whether all responses are returned.
DESCRIPTION
Returns issue security level members.
jira issue-security-scheme get [ISSUESECURITYSCHEMEID]
Returns an issue security scheme along with its security levels.
USAGE
$ jira issue-security-scheme get [ISSUESECURITYSCHEMEID] [-i <value>]
ARGUMENTS
ISSUESECURITYSCHEMEID The ID of issue security scheme.
FLAGS
-i, --id=<value>... The ID of the issue security scheme. Use the Get issue security schemes operation to get a list
of issue security scheme IDs.
DESCRIPTION
Returns an issue security scheme along with its security levels.
jira issue-security-scheme get-all
Returns all issue security schemes
USAGE
$ jira issue-security-scheme get-all
DESCRIPTION
Returns all issue security schemes
jira issue-security-scheme get-levels
Returns an issue security scheme along with its security levels.
USAGE
$ jira issue-security-scheme get-levels -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue security scheme. Use the Get issue security schemes operation to get
a list of issue security scheme IDs.
DESCRIPTION
Returns an issue security scheme along with its security levels.
jira issue-type-property delete
Deletes an issue type property.
USAGE
$ jira issue-type-property delete -i <value> --key <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type.
--key=<value> (required) The key of the property.
DESCRIPTION
Deletes an issue type property.
jira issue-type-property get
Gets issue type property.
USAGE
$ jira issue-type-property get -i <value> --key <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type.
--key=<value> (required) The key of the property.
DESCRIPTION
Gets issue type property.
jira issue-type-property get-keys
Gets issue type property keys.
USAGE
$ jira issue-type-property get-keys -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type.
DESCRIPTION
Gets issue type property keys.
jira issue-type-property set [JSONBODY]
Sets the value of the issue type property. Use this resource to store and update data against an issue type. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
USAGE
$ jira issue-type-property set [JSONBODY] -i <value> --key <value>
ARGUMENTS
JSONBODY Issue property set request in JSON format.
FLAGS
-i, --id=<value> (required) The ID of the issue type.
--key=<value> (required) The key of the property.
DESCRIPTION
Sets the value of the issue type property. Use this resource to store and update data against an issue type. The value
of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
jira issue-type-scheme add-issue-types
Adds issue types to an issue type scheme.
USAGE
$ jira issue-type-scheme add-issue-types -i <value> --issueTypeIds <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme.
--issueTypeIds=<value> (required) Issue type Id you want to add. Example usage: --issueTypeIds=1,2,3
DESCRIPTION
Adds issue types to an issue type scheme.
jira issue-type-scheme assign-to-project
Assigns an issue type scheme to a project.
USAGE
$ jira issue-type-scheme assign-to-project -i <value> --project <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme
--project=<value> (required) Project ID or Key.
DESCRIPTION
Assigns an issue type scheme to a project.
jira issue-type-scheme create
Creates an issue type schemes.
USAGE
$ jira issue-type-scheme create -n <value> --issueTypeIds <value> [-d <value>] [--defaultIssueTypeId <value>]
FLAGS
-d, --description=<value> The description of the issue type scheme.
-n, --name=<value> (required) The name of the issue type scheme. The name must be unique.
--defaultIssueTypeId=<value> The ID of the default issue type of the issue type scheme.
--issueTypeIds=<value> (required) The list of issue types IDs of the issue type scheme. At least one standard
issue type ID is required. You can provide multiple IDs by separating them with comma.
Example: --issueTypeIds=1,2,3
DESCRIPTION
Creates an issue type schemes.
jira issue-type-scheme delete
Deletes an issue type scheme.
USAGE
$ jira issue-type-scheme delete -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme.
DESCRIPTION
Deletes an issue type scheme.
jira issue-type-scheme get-for-projects
Gets issue type scheme IDs that given projects used.
USAGE
$ jira issue-type-scheme get-for-projects -p <value> [--all | --startAt <value> | --maxResults <value>]
FLAGS
-p, --project=<value>... (required) The IDs or keys of the projects. You can provide multiple values by separating
them with comma. Example: --project=1 2 3
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets issue type scheme IDs that given projects used.
jira issue-type-scheme get-issue-types
Gets issue types the issue type scheme have.
USAGE
$ jira issue-type-scheme get-issue-types -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue scheme.
DESCRIPTION
Gets issue types the issue type scheme have.
jira issue-type-scheme get-mappings
Gets issue type scheme - issue type mappings.
USAGE
$ jira issue-type-scheme get-mappings [-i <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value> Issue type schemes IDs you want to get mappings from. You can provide multiple IDs by seperating
them with comma. Example: --id=10000,10001
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets issue type scheme - issue type mappings.
jira issue-type-scheme get-projects
Gets the projects the issue type scheme is assigned to.
USAGE
$ jira issue-type-scheme get-projects -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue scheme.
DESCRIPTION
Gets the projects the issue type scheme is assigned to.
jira issue-type-scheme move-issue-types
Changes order of the issue types in an issue type scheme.
USAGE
$ jira issue-type-scheme move-issue-types -i <value> --issueTypeIds <value> [--after <value>] [--position First, Last]
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme.
--after=<value> The ID of the issue type to place the moved issue types after.
--issueTypeIds=<value> (required) Issue type Ids you want to move. Example usage: --issueTypeIds=1,2,3
--position=<option> The position the issue types should be moved to.
<options: First, Last>
DESCRIPTION
Changes order of the issue types in an issue type scheme.
jira issue-type-scheme remove-all-projects
Removes all project associations from issue type scheme.
USAGE
$ jira issue-type-scheme remove-all-projects -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme.
DESCRIPTION
Removes all project associations from issue type scheme.
jira issue-type-scheme remove-issue-type
Removes issue type from an issue type scheme.
USAGE
$ jira issue-type-scheme remove-issue-type -i <value> --issueTypeId <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme.
--issueTypeId=<value> (required) Issue type Id you want to remove.
DESCRIPTION
Removes issue type from an issue type scheme.
jira issue-type-scheme remove-project
Removes project association from issue type scheme.
USAGE
$ jira issue-type-scheme remove-project -i <value> -p <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme.
-p, --project=<value> (required) Project Ids or keys.
DESCRIPTION
Removes project association from issue type scheme.
jira issue-type-scheme search
Searches all issue type schemes. Only issue type schemes used in classic projects are returned.
USAGE
$ jira issue-type-scheme search [-i <value>] [--orderBy name|id] [--orderDirection ASC|DSC] [--query <value>] [--all |
--startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value> Issue type schemes IDs you want to get. You can provide multiple IDs by seperating them
with comma. Example: --id=10000,10001
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: name|id>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Searches all issue type schemes. Only issue type schemes used in classic projects are returned.
jira issue-type-scheme set-projects
Sets projects which assigned to issue type scheme.
USAGE
$ jira issue-type-scheme set-projects -i <value> --project <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type scheme
--project=<value>... (required) Project IDs or Keys. You can provide multiple values by separating them with comma.
Example usage: --project=1 2 3
DESCRIPTION
Sets projects which assigned to issue type scheme.
jira issue-type-scheme update
Updates an issue type schemes.
USAGE
$ jira issue-type-scheme update -i <value> [-n <value>] [-d <value>] [--defaultIssueTypeId <value>]
FLAGS
-d, --description=<value> The description of the issue type scheme.
-i, --id=<value> (required) The ID of the issue type scheme.
-n, --name=<value> The name of the issue type scheme. The name must be unique.
--defaultIssueTypeId=<value> The ID of the default issue type of the issue type scheme.
DESCRIPTION
Updates an issue type schemes.
jira issue-type-screen-scheme add-mappings
Adds issue type mappings to issue type screen scheme.
USAGE
$ jira issue-type-screen-scheme add-mappings -i <value> --mapping <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type screen scheme.
--mapping=<value>... (required) The IDs of the screen schemes for the issue type IDs and default. A default entry is
required to create an issue type screen scheme, it defines the mapping for all issue types
without a screen scheme. KEYS: [issueTypeId, screenSchemeID]
Example usage: --mapping=issueTypeId=default,screenSchemeId=10000
DESCRIPTION
Adds issue type mappings to issue type screen scheme.
jira issue-type-screen-scheme assign-to-project
Assigns an issue type screen scheme to a project.
USAGE
$ jira issue-type-screen-scheme assign-to-project -i <value> -p <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type screen scheme.
-p, --project=<value> (required) The ID or key of the project.
DESCRIPTION
Assigns an issue type screen scheme to a project.
jira issue-type-screen-scheme create
Creates an issue type screen scheme.
USAGE
$ jira issue-type-screen-scheme create -n <value> --mapping <value> [--description <value>]
FLAGS
-n, --name=<value> (required) The name of the issue type screen scheme.
--description=<value> The description of the issue type screen scheme.
--mapping=<value>... (required) The IDs of the screen schemes for the issue type IDs and default. A default entry is
required to create an issue type screen scheme, it defines the mapping for all issue types
without a screen scheme. KEYS: [issueTypeId, screenSchemeID]
Example usage: --mapping=issueTypeId=default,screenSchemeId=10000
DESCRIPTION
Creates an issue type screen scheme.
jira issue-type-screen-scheme delete
Deletes an issue type screen scheme.
USAGE
$ jira issue-type-screen-scheme delete -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type screen scheme.
DESCRIPTION
Deletes an issue type screen scheme.
jira issue-type-screen-scheme get-for-projects
Gets issue type scheme screen IDs that given projects used (project - issue type screen scheme mapping.).
USAGE
$ jira issue-type-screen-scheme get-for-projects -p <value> [--all | --startAt <value> | --maxResults <value>]
FLAGS
-p, --project=<value>... (required) The IDs or keys of the projects. You can provide multiple values by separating
them with comma. Example: --project=1 2 3
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets issue type scheme screen IDs that given projects used (project - issue type screen scheme mapping.).
jira issue-type-screen-scheme get-items
Gets issue type screen scheme items.
USAGE
$ jira issue-type-screen-scheme get-items [-i <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --ids=<value> The ID of the issue type screen scheme. You can provide multiple values by separating them with
comma. Example: --ids=1,2,3
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets issue type screen scheme items.
jira issue-type-screen-scheme get-projects
Gets projects associated with an issue type screen scheme.
USAGE
$ jira issue-type-screen-scheme get-projects -i <value> [--query <value>] [--all | --startAt <value> | --maxResults
<value>]
FLAGS
-i, --id=<value> (required) The ID of the issue type screen scheme.
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--query=<value>
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets projects associated with an issue type screen scheme.
jira issue-type-screen-scheme remove-mappings
Removes issue type to screen scheme mappings from an issue type screen scheme.
USAGE
$ jira issue-type-screen-scheme remove-mappings -i <value> --issueTypeIds <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type screen scheme.
--issueTypeIds=<value> (required) The IDs of the issue types. You can provide multiple values by separating them with
comma. Example: --isueTypeIds=1,2,3
DESCRIPTION
Removes issue type to screen scheme mappings from an issue type screen scheme.
jira issue-type-screen-scheme search
Searches issue type screen schemes.
USAGE
$ jira issue-type-screen-scheme search [-i <value>] [--orderBy name|id] [--orderDirection ASC|DSC] [--query <value>] [--all |
--startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value> Issue type screen schemes IDs you want to get. You can provide multiple IDs by seperating
them with comma. Example: --id=10000,10001
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: name|id>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Searches issue type screen schemes.
jira issue-type-screen-scheme set-default-screen
Sets the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.
USAGE
$ jira issue-type-screen-scheme set-default-screen -i <value> -s <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type screen scheme.
-s, --screenScheme=<value> (required) The ID of the screen scheme.
DESCRIPTION
Sets the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped
issue types.
jira issue-type-screen-scheme update
Updates an issue type screen scheme.
USAGE
$ jira issue-type-screen-scheme update -i <value> [-n <value>] [-d <value>]
FLAGS
-d, --description=<value> The description of the issue type screen scheme.
-i, --id=<value> (required) The ID of the issue type screen scheme.
-n, --name=<value> The name of the issue type screen scheme.
DESCRIPTION
Updates an issue type screen scheme.
jira issue-type create
Creates an issue type and adds it to the default issue type scheme
USAGE
$ jira issue-type create -n <value> [-d <value>] [-t subtype|standard] [-h 0|-1]
FLAGS
-d, --description=<value> The description of the issue type.
-h, --hierarchyLevel=<option> The hierarchy level of the issue type. Use:
"-1" for subtasks
"0" for Base
Default: 0
<options: 0|-1>
-n, --name=<value> (required) The unique name for the issue type. The maximum length is 60 characters.
-t, --type=<option> Whether the issue type is subtype or standard.
<options: subtype|standard>
DESCRIPTION
Creates an issue type and adds it to the default issue type scheme
jira issue-type delete
My description.If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId)
USAGE
$ jira issue-type delete -i <value> [--alternativeIssueTypeId <value>]
FLAGS
-i, --id=<value> (required) The ID of the issue type.
--alternativeIssueTypeId=<value> The ID of the replacement issue type.
DESCRIPTION
My description.If the issue type is in use, all uses are updated with the alternative issue type
(alternativeIssueTypeId)
jira issue-type get [ID]
Gets an issue type.
USAGE
$ jira issue-type get [ID] [-i <value>]
ARGUMENTS
ID The ID of the issue type.
FLAGS
-i, --id=<value>... The ID of the issue type.
DESCRIPTION
Gets an issue type.
jira issue-type get-all
Gets all issue types.
USAGE
$ jira issue-type get-all
DESCRIPTION
Gets all issue types.
jira issue-type get-all-for-projects
Gets issue types for a project.
USAGE
$ jira issue-type get-all-for-projects -p <value> [-l <value>]
FLAGS
-l, --level=<value> The level of the issue type to filter by. Use:
"-1" for subtasks
"0" for Base
"1" for Epic
-p, --project=<value> (required) The ID or key of the project.
DESCRIPTION
Gets issue types for a project.
jira issue-type get-alternatives
Gets a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.
USAGE
$ jira issue-type get-alternatives -i <value>
FLAGS
-i, --id=<value> (required) The ID of the issue type.
DESCRIPTION
Gets a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned
to the same workflow scheme, field configuration scheme, and screen scheme.
jira issue-type set-avatar
Sets issue type avatar.
USAGE
$ jira issue-type set-avatar -i <value> -a <value>
FLAGS
-a, --avatarId=<value> (required) The ID of the avatar.
-i, --id=<value> (required) The ID of the issue type.
DESCRIPTION
Sets issue type avatar.
jira issue-type update
Updates the issue type.
USAGE
$ jira issue-type update -i <value> [-n <value>] [-d <value>] [--avatarId <value>]
FLAGS
-d, --description=<value> The description of the issue type.
-i, --id=<value> (required) The ID of the issue type.
-n, --name=<value> The unique name for the issue type. The maximum length is 60 characters.
--avatarId=<value> The ID of an issue type avatar.
DESCRIPTION
Updates the issue type.
jira issue-type upload-avatar AVATARFILE
Uploads an avatar for the issue type.
USAGE
$ jira issue-type upload-avatar AVATARFILE -i <value> [--set] [--x <value> --y <value> --width <value>]
ARGUMENTS
AVATARFILE Location of avatar file
FLAGS
-i, --id=<value> (required) The ID of the issue type.
--set Whether the uploaded avatar will be set as issue type avatar or not.
Note: If you do not enable this flag you should update manually the issue type avatar with `jira
issue-type:set-avatar` command.
--width=<value> The length of each side of the crop region.
--x=<value> The X coordinate of the top-left corner of the crop region.
--y=<value> The Y coordinate of the top-left corner of the crop region.
DESCRIPTION
Uploads an avatar for the issue type.
jira issue-vote add
Adds the users vote to an issue.
USAGE
$ jira issue-vote add -i <value>
FLAGS
-i, --issue=<value> (required) The ID or key of the issue.
DESCRIPTION
Adds the users vote to an issue.
jira issue-vote delete
Deletes a users vote from an issue.
USAGE
$ jira issue-vote delete -i <value>
FLAGS
-i, --issue=<value> (required) The ID or key of the issue.
DESCRIPTION
Deletes a users vote from an issue.
jira issue-vote get-all
Returns details about the votes on an issue.
USAGE
$ jira issue-vote get-all -i <value>
FLAGS
-i, --issue=<value> (required) The ID or key of the issue.
DESCRIPTION
Returns details about the votes on an issue.
jira issue-watcher add
Adds a user as a watcher of an issue by passing the account ID of the user.
USAGE
$ jira issue-watcher add -i <value> -u <value>
FLAGS
-i, --issue=<value> (required) The ID or key of the issue.
-u, --user=<value> (required) Username or email.
DESCRIPTION
Adds a user as a watcher of an issue by passing the account ID of the user.
jira issue-watcher delete
Deletes a user as a watcher of an issue.
USAGE
$ jira issue-watcher delete -i <value> -u <value>
FLAGS
-i, --issue=<value> (required) The ID or key of the issue.
-u, --user=<value> (required) An identifier for the user. Use the accountId, username or an email address. Or a
search string to find a user.
DESCRIPTION
Deletes a user as a watcher of an issue.
jira issue-watcher get-all
Returns the watchers for an issue.
USAGE
$ jira issue-watcher get-all -i <value>
FLAGS
-i, --issue=<value> (required) The ID or key of the issue.
DESCRIPTION
Returns the watchers for an issue.
jira issue-watcher get-bulk
Returns, for the user, details of the watched status of issues from a list.
USAGE
$ jira issue-watcher get-bulk [-i <value>]
FLAGS
-i, --issue=<value>... The list of issue IDs or keys.
DESCRIPTION
Returns, for the user, details of the watched status of issues from a list.
jira issue archive [ISSUE]
Archives an issue.
USAGE
$ jira issue archive [ISSUE] [--issue <value>] [--notifyUsers]
ARGUMENTS
ISSUE Issue ID or key.
FLAGS
--issue=<value> Issue ID or key.
--[no-]notifyUsers Whether a notification email about the issue update is sent to all watchers.
DESCRIPTION
Archives an issue.
jira issue assign
Assigns an issue to a user. You can use this command to assign issues when the user submitting the request has the assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will remove the assignee.
USAGE
$ jira issue assign --issue <value> [-u <value>]
FLAGS
-u, --user=<value> The account ID or username or email of the user
--issue=<value> (required) Issue ID or key.
DESCRIPTION
Assigns an issue to a user. You can use this command to assign issues when the user submitting the request has the
assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will
remove the assignee.
jira issue create [ISSUEBODY]
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. You can also provide issue body using STDIN.
USAGE
$ jira issue create [ISSUEBODY] [--show --issueType <value> --project <value>] [--issueBody <value>]
[--updateHistory] [--assignee <value>] [--reporter <value>] [--security <value>] [--priority <value>] [--components
<value>] [--versions <value>] [--fixVersions <value>] [--description <value>] [--summary <value>] [--environment
<value>] [--labels <value>] [--duedate <value>] [--parent <value>] [--customFields <value>]
ARGUMENTS
ISSUEBODY Issue creation request in JSON format.
FLAGS
--assignee=<value> Assignee ID.
--components=<value> Component IDs. This flag allows comma seperated values.
--customFields=<value> Issue customfields.
Example usage: --customFields:customfield_10000="My Value",customfield_10001="Myv Value2"
--description=<value> Description of the issue.
--duedate=<value> Due date of the issue.
--environment=<value> Issue environment.
--fixVersions=<value> Fix version IDs. This flag allows comma-seperated values.
--issueBody=<value> Issue creation request in JSON format.
--issueType=<value>... The issue type id or name.
--labels=<value> Labels of the issue. This flag allows comma seperated values.
--parent=<value> Parent issue key or ID.
--priority=<value> Issue priority ID.
--project=<value>... The project id or key
--reporter=<value> Reporter ID.
--security=<value> Security level ID
--show Prepare a sample JSON output for issue creation.
--summary=<value> Summary of the issue.
--[no-]updateHistory Update issue history
--versions=<value> Version IDs. This flag allows comma-seperated values.
DESCRIPTION
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. You can also provide issue
body using STDIN.
jira issue delete [ISSUE]
If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its subtasks also being deleted.
USAGE
$ jira issue delete [ISSUE] [--issue <value>] [--deleteSubtasks]
ARGUMENTS
ISSUE Issue ID or key.
FLAGS
--deleteSubtasks Whether to delete subtasks of the issue or not.
--issue=<value> Issue ID or key.
DESCRIPTION
If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an
issue without its subtasks also being deleted.
jira issue edit [ISSUEBODY]
Edits an issue. You can also provide issue body using STDIN.
USAGE
$ jira issue edit [ISSUEBODY] --issue <value> [--issueBody <value>] [--notifyUsers] [--updateHistory]
[--overrideScreenSecurity] [--overrideEditableFlag] [--assignee <value>] [--reporter <value>] [--security <value>]
[--priority <value>] [--components <value>] [--versions <value>] [--fixVersions <value>] [--description <value>]
[--summary <value>] [--environment <value>] [--labels <value>] [--duedate <value>] [--parent <value>]
[--customFields <value>]
ARGUMENTS
ISSUEBODY Issue edit request in JSON format.
FLAGS
--assignee=<value> Assignee ID.
--components=<value> Component IDs. This flag allows comma seperated values.
--customFields=<value> Issue customfields.
Example usage: --customFields:customfield_10000="My Value",customfield_10001="Myv
Value2"
--description=<value> Description of the issue.
--duedate=<value> Due date of the issue.
--environment=<value> Issue environment.
--fixVersions=<value> Fix version IDs. This flag allows comma-seperated values.
--issue=<value> (required) Issue ID or key.
--issueBody=<value> Issue edit request in JSON format.
--labels=<value> Labels of the issue. This flag allows comma seperated values.
--[no-]notifyUsers Whether a notification email about the issue update is sent to all watchers.
--[no-]overrideEditableFlag Whether non-editable fields should be returned. Available to connect app users with
admin permissions. Only available for Jira Cloud.
--[no-]overrideScreenSecurity Whether hidden fields should be returned. Available to connect app users with admin
permissions. Only available for Jira Cloud.
--parent=<value> Parent issue key or ID.
--priority=<value> Issue priority ID.
--reporter=<value> Reporter ID.
--security=<value> Security level ID
--summary=<value> Summary of the issue.
--[no-]updateHistory Whether to add issue to user's issue history. Only available for Jira Cloud.
--versions=<value> Version IDs. This flag allows comma-seperated values.
DESCRIPTION
Edits an issue. You can also provide issue body using STDIN.
jira issue get [ISSUE]
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.
USAGE
$ jira issue get [ISSUE] [-i <value>]
ARGUMENTS
ISSUE Issue ID or key.
FLAGS
-i, --issue=<value>... Issue ID or key.
DESCRIPTION
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.
jira issue get-changelogs
Returns a list of all changelogs for an issue sorted by date, starting from the oldest.
USAGE
$ jira issue get-changelogs --issue <value> [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--issue=<value> (required) Issue ID or key.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Returns a list of all changelogs for an issue sorted by date, starting from the oldest.
jira issue get-create-metadata
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.
USAGE
$ jira issue get-create-metadata [--project <value>] [--issueType <value>]
FLAGS
--issueType=<value>... The issue type id or name.
--project=<value>... The project id or key
DESCRIPTION
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.
jira issue get-edit-metadata [ISSUE]
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.
USAGE
$ jira issue get-edit-metadata [ISSUE] [--issue <value>] [--overrideScreenSecurity] [--overrideEditableFlag]
ARGUMENTS
ISSUE Issue ID or key.
FLAGS
--issue=<value> Issue ID or key.
--[no-]overrideEditableFlag Whether non-editable fields should be returned. Available to connect app users with
admin permissions.
--[no-]overrideScreenSecurity Whether hidden fields should be returned. Available to connect app users with admin
permissions.
DESCRIPTION
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.
jira issue get-events
Returns all issue events.
USAGE
$ jira issue get-events
DESCRIPTION
Returns all issue events.
jira issue get-transitions
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
USAGE
$ jira issue get-transitions --issue <value> [--transitionId <value>] [--skipRemoteOnlyCondition]
[--includeUnavailableTransitions] [--sortByOpsBarAndStatus]
FLAGS
--[no-]includeUnavailableTransitions Whether details of transitions that fail a condition are included in the
response.
--issue=<value> (required) Issue ID or key.
--[no-]skipRemoteOnlyCondition Whether transitions with the condition Hide From User Condition are included in
the response.
--[no-]sortByOpsBarAndStatus Whether the transitions are sorted by ops-bar sequence value first then category
order (Todo, In Progress, Done) or only by ops-bar sequence value.
--transitionId=<value> Transition ID.
DESCRIPTION
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's
status.
jira issue restore [ISSUE]
Restores an issue.
USAGE
$ jira issue restore [ISSUE] [--issue <value>] [--notifyUsers]
ARGUMENTS
ISSUE Issue ID or key.
FLAGS
--issue=<value> Issue ID or key.
--[no-]notifyUsers Whether a notification email about the issue update is sent to all watchers.
DESCRIPTION
Restores an issue.
jira issue send-notifications
Edits an issue. You can also provide message body using STDIN.
USAGE
$ jira issue send-notifications --issue <value> [--subject <value>] [--htmlBody <value>] [--textBody <value>]
[--recipientUser <value>] [--recipientUserGroup <value>] [--onlyWithPermission <value>] [--onlyInUserGroup <value>]
[--notifyReporter] [--notifyAssignee] [--notifyWatchers] [--notifyVoters]
FLAGS
--htmlBody=<value> HTML body of email notification.
--issue=<value> (required) Issue ID or key.
--notifyAssignee Whether the notification should be sent to the issue's assignee.
--notifyReporter Whether the notification should be sent to the issue's reporter.
--notifyVoters Whether the notification should be sent to the issue's voters.
--notifyWatchers Whether the notification should be sent to the issue's watchers.
--onlyInUserGroup=<value>... Name of user group. Restricts the notifications to users in the user group.
--onlyWithPermission=<value>... Key of permission. Restricts the notifications to users with the specified
permissions.
--recipientUser=<value>... AccountID of user who will be notified.
--recipientUserGroup=<value>... User groups to be notified.
--subject=<value> Subject of email notification. Defaults to issue key and summary.
--textBody=<value> Text body of email notification.
DESCRIPTION
Edits an issue. You can also provide message body using STDIN.
jira issue transition [TRANSITIONBODY]
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
USAGE
$ jira issue transition [TRANSITIONBODY] --issue <value> [--transitionBody <value> | --transitionId <value>]
[--looped] [--assignee <value>] [--reporter <value>] [--security <value>] [--priority <value>] [--components
<value>] [--versions <value>] [--fixVersions <value>] [--description <value>] [--summary <value>] [--environment
<value>] [--labels <value>] [--duedate <value>] [--parent <value>] [--customFields <value>] [--requestProps <value>]
ARGUMENTS
TRANSITIONBODY Issue transition request in JSON format.
FLAGS
--assignee=<value> Assignee ID.
--components=<value> Component IDs. This flag allows comma seperated values.
--customFields=<value> Issue customfields.
Example usage: --customFields:customfield_10000="My Value",customfield_10001="Myv Value2"
--description=<value> Description of the issue.
--duedate=<value> Due date of the issue.
--environment=<value> Issue environment.
--fixVersions=<value> Fix version IDs. This flag allows comma-seperated values.
--issue=<value> (required) Issue ID or key.
--labels=<value> Labels of the issue. This flag allows comma seperated values.
--looped
--parent=<value> Parent issue key or ID.
--priority=<value> Issue priority ID.
--reporter=<value> Reporter ID.
--requestProps=<value> Additional properties for the request.
Example Usage: requestProps=resolution=resolutionName,myField=myValue
--security=<value> Security level ID
--summary=<value> Summary of the issue.
--transitionBody=<value> Issue transition request in JSON format.
--transitionId=<value> Execute a simple issue transition with just transition ID.
--versions=<value> Version IDs. This flag allows comma-seperated values.
DESCRIPTION
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's
status.
jira jira-expression analyse [JIRAEXPRESSIONBODY]
Analyses and validates Jira expressions.
USAGE
$ jira jira-expression analyse [JIRAEXPRESSIONBODY] [--show] [--check syntax|type|complexity] [--expressions <value>]
ARGUMENTS
JIRAEXPRESSIONBODY Jira expression request in JSON format.
FLAGS
--check=<option> For syntax: Each expressions syntax is checked to ensure the expression can be parsed.
For type: Each expression is type checked and the final type of the expression inferred.
Determines the formulae for how many expensive operations each expression may execute.
<options: syntax|type|complexity>
--expressions=<value>... The list of Jira expressions to analyse.
--show Prepare a sample JSON output for analyse jira expression.
DESCRIPTION
Analyses and validates Jira expressions.
jira jira-expression evaluate [JIRAEXPRESSIONBODY]
Evaluates a Jira expression and returns its value.
USAGE
$ jira jira-expression evaluate [JIRAEXPRESSIONBODY] [--show] [--expand <value>] [-e <value>]
ARGUMENTS
JIRAEXPRESSIONBODY Jira expression request in JSON format.
FLAGS
-e, --expression=<value> The Jira expression to evaluate.
--expand=<value> Use expand to include additional information in the response.
--show Prepare a sample JSON output for evaluate jira expression.
DESCRIPTION
Evaluates a Jira expression and returns its value.
jira jira-settings get-advanced
Gets the application properties that are accessible on the Advanced Settings page
USAGE
$ jira jira-settings get-advanced
DESCRIPTION
Gets the application properties that are accessible on the Advanced Settings page
jira jira-settings get-globals
Gets the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.
USAGE
$ jira jira-settings get-globals
DESCRIPTION
Gets the global settings in Jira. These settings determine whether optional features (for example, subtasks, time
tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking
configuration.
jira jira-settings get-properties
Gets all application properties or an application property.
USAGE
$ jira jira-settings get-properties [-k <value>] [-l <value>] [-f <value>]
FLAGS
-f, --keyFilter=<value> When a key isn't provided, this filters the list of results by the application property
key using a regular expression. For example, using jira.lf.* will return all
application properties with keys that start with jira.lf..
-k, --key=<value> The key of the application property.
-l, --permissionLevel=<value> The permission level of all items being returned in the list.
DESCRIPTION
Gets all application properties or an application property.
jira jira-settings set-property
Sets the value of an application property. You can get known keys with jira jira-setting:get-advanced command.
USAGE
$ jira jira-settings set-property -k <value> [-v <value>]
FLAGS
-k, --key=<value> (required) The key of the application property to update.
-v, --value=<value> The new value.
DESCRIPTION
Sets the value of an application property. You can get known keys with jira jira-setting:get-advanced command.
jira jql convert-user-identifiers
Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.
USAGE
$ jira jql convert-user-identifiers -q <value>
FLAGS
-q, --query=<value>... (required) A query to parse.
DESCRIPTION
Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account
IDs.
jira jql get-auto-complete-suggestions
Returns the JQL search auto complete suggestions for a field.
USAGE
$ jira jql get-auto-complete-suggestions [--fieldName <value>] [--fieldValue <value>] [--predicateName <value>] [--predicateValue
<value>]
FLAGS
--fieldName=<value> The name of the field.
--fieldValue=<value> The partial field item name entered by the user.
--predicateName=<value> The name of the CHANGED operator predicate for which the suggestions are generated. The
valid predicate operators are by, from, and to.
--predicateValue=<value> The partial predicate item name entered by the user.
DESCRIPTION
Returns the JQL search auto complete suggestions for a field.
jira jql get-reference-data
Fets reference data for JQL searches
USAGE
$ jira jql get-reference-data [-p <value>] [-i]
FLAGS
-i, --includeCollapsedFields Include collapsed fields for fields that have non-unique names.
-p, --project=<value>... List of project IDs or keys used to filter the visible field details returned.
DESCRIPTION
Fets reference data for JQL searches
jira jql parse
Parses and validates JQL queries.
USAGE
$ jira jql parse -q <value> [-v strict|warn|none]
FLAGS
-q, --query=<value>... (required) A query to parse.
-v, --validation=<option> How to validate the JQL query and treat the validation results.
<options: strict|warn|none>
DESCRIPTION
Parses and validates JQL queries.
jira jql sanitize
Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view the entity.
USAGE
$ jira jql sanitize -q <value>
FLAGS
-q, --query=<value>... (required) JQL queries to sanitize. Must contain unique values.
DESCRIPTION
Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view
the entity.
jira label get-all
Returns a paginated list of labels.
USAGE
$ jira label get-all [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Returns a paginated list of labels.
jira license get
Returns licensing information about the Jira instance.
USAGE
$ jira license get
DESCRIPTION
Returns licensing information about the Jira instance.
jira myself change-password
Modify caller password.
USAGE
$ jira myself change-password -p <value> -c <value>
FLAGS
-c, --currentPassword=<value> (required) current password
-p, --password=<value> (required) new password
DESCRIPTION
Modify caller password.
jira myself delete-preference
Deletes a preference of the user, which restores the default value of system defined settings.
USAGE
$ jira myself delete-preference -k <value>
FLAGS
-k, --key=<value> (required) The key of the preference.
DESCRIPTION
Deletes a preference of the user, which restores the default value of system defined settings.
jira myself get
Returns currently logged user.
USAGE
$ jira myself get
DESCRIPTION
Returns currently logged user.
jira myself get-locale
Returns the locale for the user.
USAGE
$ jira myself get-locale
DESCRIPTION
Returns the locale for the user.
jira myself get-preference
Returns the value of a preference of the current user.
USAGE
$ jira myself get-preference [-k <value>]
FLAGS
-k, --key=<value>... The key of the preference.
DESCRIPTION
Returns the value of a preference of the current user.
jira myself set-preference [PREFERENCEBODY]
Creates a preference for the user or updates a preferences value by sending a plain text string.
USAGE
$ jira myself set-preference [PREFERENCEBODY] -k <value> [--text <value>]
ARGUMENTS
PREFERENCEBODY Preference json file.
FLAGS
-k, --key=<value> (required) The key of the preference.
--text=<value> Preference for the user or updates a preferences value by sending a plain text string.
DESCRIPTION
Creates a preference for the user or updates a preferences value by sending a plain text string.
jira myself update-user
Modify currently logged user.
USAGE
$ jira myself update-user -p <value> [-e <value>] [-d <value>]
FLAGS
-d, --displayName=<value> Change display name
-e, --emailAddress=<value> Change e-mail address.
-p, --password=<value> (required) Enter the current user password.
DESCRIPTION
Modify currently logged user.
jira notification-scheme add [NOTIFICATIONBODY]
Adds notifications to a notifications scheme.
USAGE
$ jira notification-scheme add [NOTIFICATIONBODY] [--show] [-i <value>] [--eventId <value>] [-t <value>] [--parameter
<value>]
ARGUMENTS
NOTIFICATIONBODY Notification scheme creation request in JSON format.
FLAGS
-i, --id=<value> The ID of the notification scheme.
-t, --notificationType=<value> The notification type, e.g CurrentAssignee, Group, EmailAddress.
--eventId=<value> The ID of the notification scheme event.
--parameter=<value> The value corresponding to the specified notification type.
--show Prepare a sample JSON output for notification scheme creation.
DESCRIPTION
Adds notifications to a notifications scheme.
jira notification-scheme create [NOTIFICATIONBODY]
Creates a notification scheme with notifications.
USAGE
$ jira notification-scheme create [NOTIFICATIONBODY] [--show] [-n <value>] [--description <value>] [--eventId <value>] [-t
<value>] [--parameter <value>]
ARGUMENTS
NOTIFICATIONBODY Notification scheme creation request in JSON format.
FLAGS
-n, --name=<value> The name of the notification scheme. Must be unique (case-insensitive).
-t, --notificationType=<value> The notification type, e.g CurrentAssignee, Group, EmailAddress.
--description=<value> The description of the notification scheme.
--eventId=<value> The ID of the notification scheme event.
--parameter=<value> The value corresponding to the specified notification type.
--show Prepare a sample JSON output for notification scheme creation.
DESCRIPTION
Creates a notification scheme with notifications.
jira notification-scheme delete
Deletes a notification scheme.
USAGE
$ jira notification-scheme delete -i <value>
FLAGS
-i, --notificationSchemeId=<value> (required) The ID of the notification scheme.
DESCRIPTION
Deletes a notification scheme.
jira notification-scheme delete-notification
Removes a notification from a notification scheme.
USAGE
$ jira notification-scheme delete-notification -i <value> -n <value>
FLAGS
-i, --notificationSchemeId=<value> (required) The ID of the notification scheme.
-n, --notificationId=<value> (required) The ID of the notification.
DESCRIPTION
Removes a notification from a notification scheme.
jira notification-scheme get
Returns a paginated notification scheme ordered by the display name from given id.
USAGE
$ jira notification-scheme get -i <value> [--expand all|field|group|notificationSchemeEvents|projectRole|user] [--all
| | ]
FLAGS
-i, --id=<value>... (required) The list of notification schemes IDs to be filtered by. Only for cloud.
--all Whether all responses are returned.
--expand=<option> Use expand to include additional information in the response. This parameter accepts a
comma-separated list.
<options: all|field|group|notificationSchemeEvents|projectRole|user>
DESCRIPTION
Returns a paginated notification scheme ordered by the display name from given id.
jira notification-scheme get-all
Returns a paginated list of notification schemes ordered by the display name.
USAGE
$ jira notification-scheme get-all [--id <value>] [--project <value>] [--onlyDefault] [--expand
all|field|group|notificationSchemeEvents|projectRole|user] [--all | | ]
FLAGS
--all Whether all responses are returned.
--expand=<option> Use expand to include additional information in the response. This parameter accepts a
comma-separated list.
<options: all|field|group|notificationSchemeEvents|projectRole|user>
--id=<value>... The list of notification schemes IDs to be filtered by. Only for cloud.
--onlyDefault When set to true, returns only the default notification scheme. If you provide project IDs not
associated with the default, returns an empty page. The default value is false.
--project=<value>... The list of projects IDs or keys to be filtered by. Only for cloud. Example usage: -p 1 2 3
DESCRIPTION
Returns a paginated list of notification schemes ordered by the display name.
jira notification-scheme get-projects
Returns a paginated mapping of project that have notification scheme assigned.
USAGE
$ jira notification-scheme get-projects [-i <value>] [-p <value>] [--all | | ]
FLAGS
-i, --notificationSchemeId=<value>... The list of notifications scheme IDs to be filtered out
-p, --project=<value>... The list of project IDs to be filtered out. Example usage -p 1 2 3
--all Whether all responses are returned.
DESCRIPTION
Returns a paginated mapping of project that have notification scheme assigned.
jira notification-scheme update
Updates a notification scheme.
USAGE
$ jira notification-scheme update -i <value> [--name <value>] [--description <value>]
FLAGS
-i, --id=<value> (required) The ID of the notification scheme.
--description=<value> The description of the notification scheme.
--name=<value> The name of the notification scheme. Must be unique.
DESCRIPTION
Updates a notification scheme.
jira permission-scheme create-grant
Creates a permission grant in a permission scheme.
USAGE
$ jira permission-scheme create-grant -i <value> -t
anyone|applicationRole|assignee|group|groupCustomField|projectLead|projectRole|reporter|sd.customer.portal.only|user
|userCustomField [-p <value>] [-r <value>] [--permission <value>]
FLAGS
-i, --schemeId=<value> (required) The ID of the permission scheme in which to create a new permission grant.
-p, --holderParameter=<value> As a groups name can change, use of value is recommended.
-r, --projectRole=<value> The identifier associated with the type value that defines the holder of the
permission.
-t, --holderType=<option> (required) The type of permission holder.
<options: anyone|applicationRole|assignee|group|groupCustomField|projectLead|projectRol
e|reporter|sd.customer.portal.only|user|userCustomField>
--permission=<value> The permission to grant.To see built-in permissions:
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-scheme
s/#api-rest-api-3-permissionscheme-get
DESCRIPTION
Creates a permission grant in a permission scheme.
jira permission-scheme create-scheme
Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.
USAGE
$ jira permission-scheme create-scheme -n <value> [--description <value>]
FLAGS
-n, --name=<value> (required) The name of the permission scheme. Must be unique.
--description=<value> A description for the permission scheme.
DESCRIPTION
Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission
grants.
jira permission-scheme delete-grant
Deletes a permission grant from a permission scheme.
USAGE
$ jira permission-scheme delete-grant -i <value> -p <value>
FLAGS
-i, --schemeId=<value> (required) The ID of the permission scheme to delete the permission grant from.
-p, --permissionId=<value> (required) The ID of the permission grant to delete.
DESCRIPTION
Deletes a permission grant from a permission scheme.
jira permission-scheme delete-scheme
Deletes a permission scheme.
USAGE
$ jira permission-scheme delete-scheme -i <value>
FLAGS
-i, --schemeId=<value> (required) The ID of the permission scheme being deleted.
DESCRIPTION
Deletes a permission scheme.
jira permission-scheme get
Returns a permission scheme.
USAGE
$ jira permission-scheme get -i <value> [--expand permissions|user|group|all|projectRole|field]
FLAGS
-i, --schemeId=<value> (required) The ID of the permission scheme to return.
--expand=<option> Use expand to include additional information in the response.
<options: permissions|user|group|all|projectRole|field>
DESCRIPTION
Returns a permission scheme.
jira permission-scheme get-all
Returns all permission schemes.
USAGE
$ jira permission-scheme get-all [--expand permissions|user|group|all|projectRole|field]
FLAGS
--expand=<option> Use expand to include additional information in the response.
<options: permissions|user|group|all|projectRole|field>
DESCRIPTION
Returns all permission schemes.
jira permission-scheme get-all-grants
Returns all permission grants for a permission scheme.
USAGE
$ jira permission-scheme get-all-grants -i <value> [--expand permissions|user|group|all|projectRole|field]
FLAGS
-i, --schemeId=<value> (required) The ID of the permission scheme to return.
--expand=<option> Use expand to include additional information in the response.
<options: permissions|user|group|all|projectRole|field>
DESCRIPTION
Returns all permission grants for a permission scheme.
jira permission-scheme get-grant
Returns a permission grant.
USAGE
$ jira permission-scheme get-grant -i <value> -p <value> [--expand permissions|user|group|all|projectRole|field]
FLAGS
-i, --schemeId=<value> (required) The ID of the permission scheme.
-p, --permissionId=<value> (required) The ID of the permission grant.
--expand=<option> Use expand to include additional information in the response.
<options: permissions|user|group|all|projectRole|field>
DESCRIPTION
Returns a permission grant.
jira permission check-global-permission
Check global permissions
USAGE
$ jira permission check-global-permission [-g <value>] [-u <value>]
FLAGS
-g, --globalPermissions=<value>... Global permissions to look up.
-u, --user=<value> The account ID or username or email of a user.
DESCRIPTION
Check global permissions
jira permission check-issue-permission
Check the issue permissions.
USAGE
$ jira permission check-issue-permission -p <value> [--user <value>] [--issues <value>]
FLAGS
-p, --permission=<value> (required) List of project permissions.
--issues=<value> List of issue IDs.
--user=<value> The account ID or email or username of a user.
DESCRIPTION
Check the issue permissions.
jira permission check-project-permission
Check the project permissions.
USAGE
$ jira permission check-project-permission -p <value> [-u <value>] [-p <value>]
FLAGS
-p, --permission=<value>... (required) List of project permissions.
-p, --project=<value>... List of project ID or keys.
-u, --user=<value> The account ID or username or email of a user.
DESCRIPTION
Check the project permissions.
jira permission get-all
Returns all permissions, including:global permissions.project permissions.global permissions added by plugins.
USAGE
$ jira permission get-all
DESCRIPTION
Returns all permissions, including:global permissions.project permissions.global permissions added by plugins.
jira permission get-my
Returns a list of permissions indicating which permissions the user has. Details of the user"s permissions can be obtained in a global, project, issue or comment context.
USAGE
$ jira permission get-my --permissions <value> [-p <value>] [-i <value>] [--projectUuid <value>]
[--projectConfigurationUuid <value>] [--commentId <value>]
FLAGS
-i, --issue=<value> Issue id or key
-p, --project=<value> Project id or key
--commentId=<value> Comment Id
--permissions=<value> (required) A list of permission keys. (Required) This parameter accepts a
comma-separated list. To get the list of available permissions, use Get all
permissions.
--projectConfigurationUuid=<value> Project configuration Uuid
--projectUuid=<value> Project Uuid
DESCRIPTION
Returns a list of permissions indicating which permissions the user has. Details of the user"s permissions can be
obtained in a global, project, issue or comment context.
jira permission get-permitted [PERMISSION]
Returns all the projects where the user is granted a list of project permissions.
USAGE
$ jira permission get-permitted [PERMISSION] [-p <value>]
ARGUMENTS
PERMISSION Permission key.
FLAGS
-p, --permission=<value>... A permission key.
DESCRIPTION
Returns all the projects where the user is granted a list of project permissions.
jira plugins
List installed plugins.
USAGE
$ jira plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ jira plugins
See code: @oclif/plugin-plugins
jira plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ jira plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ jira plugins add
EXAMPLES
$ jira plugins:install myplugin
$ jira plugins:install https://github.com/someuser/someplugin
$ jira plugins:install someuser/someplugin
jira plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ jira plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ jira plugins:inspect myplugin
jira plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ jira plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ jira plugins add
EXAMPLES
$ jira plugins:install myplugin
$ jira plugins:install https://github.com/someuser/someplugin
$ jira plugins:install someuser/someplugin
jira plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ jira plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ jira plugins:link myplugin
jira plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ jira plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ jira plugins unlink
$ jira plugins remove
jira plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ jira plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ jira plugins unlink
$ jira plugins remove
jira plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ jira plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ jira plugins unlink
$ jira plugins remove
jira plugins update
Update installed plugins.
USAGE
$ jira plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
jira project-avatar delete
Deletes a custom avatar from a project. Note that system avatars cannot be deleted.
USAGE
$ jira project-avatar delete -p <value> --avatarId <value>
FLAGS
-p, --project=<value> (required) Project id or key
--avatarId=<value> (required) The ID of the avatar.
DESCRIPTION
Deletes a custom avatar from a project. Note that system avatars cannot be deleted.
jira project-avatar get-all
Returns all project avatars, grouped by system and custom avatars.
USAGE
$ jira project-avatar get-all -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Returns all project avatars, grouped by system and custom avatars.
jira project-avatar set
Sets the project avatar to an already uploaded/existing avatar.
USAGE
$ jira project-avatar set -p <value> --avatarId <value>
FLAGS
-p, --project=<value> (required) Project id or key
--avatarId=<value> (required) The ID of the avatar.
DESCRIPTION
Sets the project avatar to an already uploaded/existing avatar.
jira project-avatar upload AVATARFILE
Uploads an avatar for a project.
USAGE
$ jira project-avatar upload AVATARFILE -p <value> [--x <value> --y <value> --width <value>]
ARGUMENTS
AVATARFILE Location of avatar file
FLAGS
-p, --project=<value> (required) Project id or key
--width=<value> The length of each side of the crop region.
--x=<value> The X coordinate of the top-left corner of the crop region.
--y=<value> The Y coordinate of the top-left corner of the crop region.
DESCRIPTION
Uploads an avatar for a project.
jira project-category create
Creates a project category.
USAGE
$ jira project-category create -n <value> -d <value>
FLAGS
-d, --description=<value> (required) The description of the project category.
-n, --name=<value> (required) The name of the project category.
DESCRIPTION
Creates a project category.
jira project-category delete
Deletes a project category.
USAGE
$ jira project-category delete -i <value>
FLAGS
-i, --id=<value> (required) The ID of the project category.
DESCRIPTION
Deletes a project category.
jira project-category get [ID]
Returns a project category.
USAGE
$ jira project-category get [ID] [-i <value>]
ARGUMENTS
ID The ID of the project category.
FLAGS
-i, --id=<value>... The ID of the project category.
DESCRIPTION
Returns a project category.
jira project-category get-all
Returns all project categories.
USAGE
$ jira project-category get-all
DESCRIPTION
Returns all project categories.
jira project-category update
Updates a project category.
USAGE
$ jira project-category update -i <value> [-n <value>] [-d <value>]
FLAGS
-d, --description=<value> The description of the project category.
-i, --id=<value> (required) The ID of the project category.
-n, --name=<value> The name of the project category.
DESCRIPTION
Updates a project category.
jira project-component create
Creates a component. Use components to provide containers for issues within a project.
USAGE
$ jira project-component create --name <value> [--pId <value> | --pKey <value>] [--description <value>] [--assigneeType
PROJECT_LEAD|UNASSIGNED|PROJECT_DEFAULT|COMPONENT_LEAD] [--lead <value> | --leadAccountId <value> | --leadUsername
<value>]
FLAGS
--assigneeType=<option> The nominal user type used to determine the assignee for issues created with this component.
<options: PROJECT_LEAD|UNASSIGNED|PROJECT_DEFAULT|COMPONENT_LEAD>
--description=<value> The description for the component.
--lead=<value> The user name or accountId of the component lead. Can be used both server or cloud.
--leadAccountId=<value> The account ID of the component lead. Only applicable to cloud.
--leadUsername=<value> The user name of the component lead. Only applicable to server.
--name=<value> (required) The unique name for the component in the project. The maximum length is 255
characters.
--pId=<value> project id
--pKey=<value> project key
DESCRIPTION
Creates a component. Use components to provide containers for issues within a project.
jira project-component delete
Deletes a project component.
USAGE
$ jira project-component delete -i <value> [-t <value>]
FLAGS
-i, --id=<value> (required) The ID of the component.
-t, --moveIssuesTo=<value> The ID of the component to replace the deleted component. If this value is null no
replacement is made.
DESCRIPTION
Deletes a project component.
jira project-component get [ID]
Returns a project component.
USAGE
$ jira project-component get [ID] [-i <value>]
ARGUMENTS
ID The ID of the component.
FLAGS
-i, --id=<value>... The ID of the component.
DESCRIPTION
Returns a project component.
jira project-component get-all
Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.
USAGE
$ jira project-component get-all [-p <value>]
FLAGS
-p, --project=<value> Project id or key
DESCRIPTION
Returns all components in a project. See the Get project components paginated resource if you want to get a full list
of components with pagination.
jira project-component get-issues-count
Returns the counts of issues assigned to the component.
USAGE
$ jira project-component get-issues-count -i <value>
FLAGS
-i, --id=<value> (required) The ID of the component.
DESCRIPTION
Returns the counts of issues assigned to the component.
jira project-component search
Search for project components. This command is only applicable to Jira Cloud
USAGE
$ jira project-component search [-p <value>] [--startAt <value>] [--maxResults <value>] [--orderBy
description|name|releaseDate|sequence|startDate] [--orderDirection ASC|DSC] [--query <value>]
FLAGS
-p, --project=<value> Project id or key
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: description|name|releaseDate|sequence|startDate>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Search for project components. This command is only applicable to Jira Cloud
jira project-component update
Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed.
USAGE
$ jira project-component update -i <value> [--name <value>] [--description <value>] [--assigneeType
PROJECT_LEAD|UNASSIGNED|PROJECT_DEFAULT|COMPONENT_LEAD] [--lead <value> | --leadAccountId <value> | --leadUsername
<value>]
FLAGS
-i, --id=<value> (required) Id of the component to be updated.
--assigneeType=<option> The nominal user type used to determine the assignee for issues created with this component.
<options: PROJECT_LEAD|UNASSIGNED|PROJECT_DEFAULT|COMPONENT_LEAD>
--description=<value> The description for the component.
--lead=<value> The user name or accountId of the component lead. Can be used both server or cloud.
--leadAccountId=<value> The account ID of the component lead. Only applicable to cloud.
--leadUsername=<value> The user name of the component lead. Only applicable to server.
--name=<value> The unique name for the component in the project. The maximum length is 255 characters.
DESCRIPTION
Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the
component lead is removed.
jira project-email get-sender
Gets the project's sender email
USAGE
$ jira project-email get-sender -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Gets the project's sender email
jira project-email set-sender
Sets the project's sender email
USAGE
$ jira project-email set-sender -p <value> --email <value>
FLAGS
-p, --project=<value> (required) Project id or key
--email=<value> (required) email address
DESCRIPTION
Sets the project's sender email
jira project-feature get [PROJECT]
This resource represents project features. Use it to get the list of features for a project and modify the state of a feature.
USAGE
$ jira project-feature get [PROJECT] [-p <value>]
ARGUMENTS
PROJECT The ID or (case-sensitive) key of the project.
FLAGS
-p, --project=<value>... The ID or (case-sensitive) key of the project.
DESCRIPTION
This resource represents project features. Use it to get the list of features for a project and modify the state of a
feature.
jira project-feature set
Sets the state of a project feature.
USAGE
$ jira project-feature set -p <value> -f <value> -t ENABLED|DISABLED|COMING_SOON
FLAGS
-f, --featureKey=<value> (required) The key of the feature.
-p, --project=<value> (required) The ID or (case-sensitive) key of the project.
-t, --state=<option> (required) The feature state. Example usage: -t=ENABLED
<options: ENABLED|DISABLED|COMING_SOON>
DESCRIPTION
Sets the state of a project feature.
jira project-key-and-name-validation get-valid-key
Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.
USAGE
$ jira project-key-and-name-validation get-valid-key [-k <value>]
FLAGS
-k, --key=<value> project key
DESCRIPTION
Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.
jira project-key-and-name-validation get-valid-name
Validates a project name and, if the name is invalid or in use, generates a valid random string for the project name.
USAGE
$ jira project-key-and-name-validation get-valid-name [-n <value>]
FLAGS
-n, --name=<value> project name
DESCRIPTION
Validates a project name and, if the name is invalid or in use, generates a valid random string for the project name.
jira project-key-and-name-validation validate-key
Validates a project key by confirming the key is a valid string and not in use.
USAGE
$ jira project-key-and-name-validation validate-key [-k <value>]
FLAGS
-k, --key=<value> project key
DESCRIPTION
Validates a project key by confirming the key is a valid string and not in use.
jira project-permission-scheme get
Gets permission schema of project.
USAGE
$ jira project-permission-scheme get -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Gets permission schema of project.
jira project-permission-scheme get-issue-security-levels
Returns "issue security" levels for the project that the user has access to
USAGE
$ jira project-permission-scheme get-issue-security-levels -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Returns "issue security" levels for the project that the user has access to
jira project-permission-scheme get-issue-security-scheme
Returns the issue security scheme associated with the project
USAGE
$ jira project-permission-scheme get-issue-security-scheme -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Returns the issue security scheme associated with the project
jira project-permission-scheme get-issue-security-scheme-levels
Returns the issue security scheme levels associated with the project
USAGE
$ jira project-permission-scheme get-issue-security-scheme-levels -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Returns the issue security scheme levels associated with the project
jira project-permission-scheme get-permissions
Gets permissions of project's permission schema
USAGE
$ jira project-permission-scheme get-permissions -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Gets permissions of project's permission schema
jira project-permission-scheme set
Assigns permission schema to a project.
USAGE
$ jira project-permission-scheme set -p <value> --schemeId <value>
FLAGS
-p, --project=<value> (required) Project id or key
--schemeId=<value> (required) Permission scheme id.
DESCRIPTION
Assigns permission schema to a project.
jira project-property delete
Remove a property from project's entity properties
USAGE
$ jira project-property delete -p <value> --propertyKey <value>
FLAGS
-p, --project=<value> (required) Project id or key
--propertyKey=<value> (required) The project property key.
DESCRIPTION
Remove a property from project's entity properties
jira project-property get
Returns the value of a project property.
USAGE
$ jira project-property get -p <value> --propertyKey <value>
FLAGS
-p, --project=<value> (required) Project id or key
--propertyKey=<value> (required) The project property key.
DESCRIPTION
Returns the value of a project property.
jira project-property get-keys
Returns all project property keys for the project.
USAGE
$ jira project-property get-keys -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Returns all project property keys for the project.
jira project-property set
Set the value (JSON) of a project property.
USAGE
$ jira project-property set -p <value> --propertyKey <value> [--propertyValue <value>]
FLAGS
-p, --project=<value> (required) Project id or key
--propertyKey=<value> (required) The project property key.
--propertyValue=<value> Value of the property.
DESCRIPTION
Set the value (JSON) of a project property.
jira project-role-actor add-actors
Adds default actors tor project role
USAGE
$ jira project-role-actor add-actors -i <value> [-p <value>] [--user <value>] [-g <value>]
FLAGS
-g, --group=<value>... The names or ids of the group that you want to add users to.
-i, --id=<value> (required) The ID of the project role.
-p, --project=<value> The project ID or project key (case sensitive).
--user=<value>... Username for Server/DC and accountId or username or email for Cloud
DESCRIPTION
Adds default actors tor project role
jira project-role-actor add-default-actors
Adds default actors to a role.
USAGE
$ jira project-role-actor add-default-actors -i <value> [--user <value>] [--group <value>]
FLAGS
-i, --id=<value> (required) The ID of the project role.
--group=<value>... The name or id of the group to add as a default actor.
--user=<value>... The account IDs or usernames or emails of the users to add as default actors.
DESCRIPTION
Adds default actors to a role.
jira project-role-actor delete-actors
Deletes the default actors from a project role
USAGE
$ jira project-role-actor delete-actors -p <value> -i <value> [-u <value>] [--group <value>]
FLAGS
-i, --id=<value> (required) The ID of the project role.
-p, --project=<value> (required) The project ID or project key (case sensitive).
-u, --user=<value> Username for Server/DC and accountId or email or username for Cloud
--group=<value>... The name or id of the group to add as a default actor.
DESCRIPTION
Deletes the default actors from a project role
jira project-role-actor delete-default-actors
Deletes the default actors from a project role.
USAGE
$ jira project-role-actor delete-default-actors -i <value> [--user <value>] [--group <value>]
FLAGS
-i, --id=<value> (required) The ID of the project role.
--group=<value> The name or id of the group to add as a default actor.
--user=<value> The user account ID or email or username of the user to remove as a default actor.
DESCRIPTION
Deletes the default actors from a project role.
jira project-role-actor get
Returns the default actors for the project role.
USAGE
$ jira project-role-actor get -i <value>
FLAGS
-i, --id=<value> (required) The ID of the project role.
DESCRIPTION
Returns the default actors for the project role.
jira project-role-actor set-actors
Sets the actors for a project role for a project, replacing all existing actors.
USAGE
$ jira project-role-actor set-actors -p <value> -i <value> [-u <value>] [--group <value>]
FLAGS
-i, --id=<value> (required) The ID of the project role.
-p, --project=<value> (required) Project Id or key.
-u, --user=<value>... Username for Server/DC and accountId or username or email for Cloud
--group=<value>... The name or id of the group to add as a default actor.
DESCRIPTION
Sets the actors for a project role for a project, replacing all existing actors.
jira project-role create
Returns details of a project role
USAGE
$ jira project-role create -n <value> [-d <value>]
FLAGS
-d, --description=<value> description
-n, --name=<value> (required) name
DESCRIPTION
Returns details of a project role
jira project-role delete
Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.
USAGE
$ jira project-role delete -i <value> [--replacementRoleId <value>]
FLAGS
-i, --id=<value> (required) role id
--replacementRoleId=<value> Replacement role id for existing projects
DESCRIPTION
Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in
use.
jira project-role get [ID]
Returns details of a project role
USAGE
$ jira project-role get [ID] [-i <value>]
ARGUMENTS
ID Role Id.
FLAGS
-i, --id=<value>... Role Id.
DESCRIPTION
Returns details of a project role
jira project-role get-all
Returns all project roles and the details for each role
USAGE
$ jira project-role get-all
DESCRIPTION
Returns all project roles and the details for each role
jira project-role get-role
My description
USAGE
$ jira project-role get-role -p <value> [-i <value>]
FLAGS
-i, --roleId=<value>... Role Id.
-p, --project=<value> (required) The project ID or project key (case sensitive).
DESCRIPTION
My description
jira project-role get-roles
Returns a list of project roles for the project returning the name and self URL for each role.
USAGE
$ jira project-role get-roles -p <value>
FLAGS
-p, --project=<value> (required) The project ID or project key (case sensitive).
DESCRIPTION
Returns a list of project roles for the project returning the name and self URL for each role.
jira project-role get-roles-and-details
Returns all project roles and the details for each role.
USAGE
$ jira project-role get-roles-and-details -p <value>
FLAGS
-p, --project=<value> (required) The project ID or project key (case sensitive).
DESCRIPTION
Returns all project roles and the details for each role.
jira project-role project-role
Shows help about project role commands
USAGE
$ jira project-role project-role
DESCRIPTION
Shows help about project role commands
jira project-role update
Updates the project role's name and description. You must include both a name and a description in the request.
USAGE
$ jira project-role update -i <value> -n <value> -d <value>
FLAGS
-d, --description=<value> (required) description
-i, --id=<value> (required) role id
-n, --name=<value> (required) name
DESCRIPTION
Updates the project role's name and description. You must include both a name and a description in the request.
jira project-role update-partial
Updates either the project roles name or its description.
USAGE
$ jira project-role update-partial [-i <value>] [-n <value>] [--description <value>]
FLAGS
-i, --id=<value> The ID of the project role.
-n, --name=<value> The name of the project role.
--description=<value> A description of the project role.
DESCRIPTION
Updates either the project roles name or its description.
jira project-type check-accessible
Gets details of a project type if it is accessible for current user
USAGE
$ jira project-type check-accessible [-k <value>]
FLAGS
-k, --key=<value> Key of project type
DESCRIPTION
Gets details of a project type if it is accessible for current user
jira project-type get [KEY]
Gets details of a project type
USAGE
$ jira project-type get [KEY] [-k <value>]
ARGUMENTS
KEY Key of project type.
FLAGS
-k, --key=<value>... Key of project type.
DESCRIPTION
Gets details of a project type
jira project-type get-all
Returns all project types whether or not the instance has a valid license for each type
USAGE
$ jira project-type get-all
DESCRIPTION
Returns all project types whether or not the instance has a valid license for each type
jira project-type get-licensed
Returns all project types whether or not the instance has a valid license for each type
USAGE
$ jira project-type get-licensed
DESCRIPTION
Returns all project types whether or not the instance has a valid license for each type
jira project-type update
Updates project type of a project
USAGE
$ jira project-type update --typeKey <value> [-p <value>]
FLAGS
-p, --project=<value> Project id or key
--typeKey=<value> (required) Key of project type
DESCRIPTION
Updates project type of a project
jira project-version create
Creates a new project version.
USAGE
$ jira project-version create -p <value> --name <value> [--description <value>] [--startDate <value>] [--released]
[--releaseDate <value>] [--archived]
FLAGS
-p, --project=<value> (required) Project id or key
--[no-]archived Version is archived.
--description=<value> Description of version.
--name=<value> (required) Name of version.
--releaseDate=<value> Release date of version.
--[no-]released Version is released.
--startDate=<value> Start date of version.
DESCRIPTION
Creates a new project version.
jira project-version delete-and-replace
Deletes a project version. Alternative versions can be provided to update issues that use the deleted version.
USAGE
$ jira project-version delete-and-replace -i <value> [-f <value>] [-a <value>] [-c <value>]
FLAGS
-a, --moveAffectedIssuesTo=<value> The ID of the version to update affectedVersion to when the field contains
the deleted version.
-c, --customFieldReplacement=<value>... An array of custom field IDs (customFieldId) and version IDs (moveTo) to
update when the fields contain the deleted version. Ex:
--customFieldReplacement="{\"customFieldId\":10100, \"moveTo\":1002}"
-f, --moveFixIssuesTo=<value> The ID of the version to update fixVersion to when the field contains the
deleted version.
-i, --id=<value> (required) Id of the version to be deleted.
DESCRIPTION
Deletes a project version. Alternative versions can be provided to update issues that use the deleted version.
jira project-version get [ID]
Returns a project version.
USAGE
$ jira project-version get [ID] [-i <value>]
ARGUMENTS
ID version id
FLAGS
-i, --id=<value>... version id
DESCRIPTION
Returns a project version.
jira project-version get-all
Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.
USAGE
$ jira project-version get-all -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to
get the versions in a project with pagination.
jira project-version get-related-issue-count
Returns number of issues for each version field.
USAGE
$ jira project-version get-related-issue-count -i <value>
FLAGS
-i, --id=<value> (required) version id
DESCRIPTION
Returns number of issues for each version field.
jira project-version get-unresolved-issue-count
Returns counts of the issues and unresolved issues for the project version.
USAGE
$ jira project-version get-unresolved-issue-count -i <value>
FLAGS
-i, --id=<value> (required) version id
DESCRIPTION
Returns counts of the issues and unresolved issues for the project version.
jira project-version merge
Merges two project versions. The merge is completed by deleting the version specified in id and replacing any occurrences of its ID in fixVersion with the version ID specified in moveIssuesTo.
USAGE
$ jira project-version merge -i <value> -t <value>
FLAGS
-i, --id=<value> (required) The ID of the version to delete.
-t, --moveIssuesTo=<value> (required) The ID of the version to merge into.
DESCRIPTION
Merges two project versions. The merge is completed by deleting the version specified in id and replacing any
occurrences of its ID in fixVersion with the version ID specified in moveIssuesTo.
Consider using Delete and replace version instead. This resource supports swapping version values in fixVersion,
affectedVersion, and custom fields.
jira project-version move
Modifies the version's sequence within the project, which affects the display order of the versions in Jira.
USAGE
$ jira project-version move -i <value> [--after <value> | --position Earlier|Later|First|Last]
FLAGS
-i, --id=<value> (required) The ID of the version to move.
--after=<value> The URL (self link) of the version after which to place the moved version. Cannot be used with
position.
--position=<option> An absolute position in which to place the moved version. Cannot be used with after.
<options: Earlier|Later|First|Last>
DESCRIPTION
Modifies the version's sequence within the project, which affects the display order of the versions in Jira.
jira project-version search
Search for project components. This command is only applicable to Jira Cloud
USAGE
$ jira project-version search -p <value> [--orderBy description|name|releaseDate|sequence|startDate] [--orderDirection
ASC|DSC] [--query <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-p, --project=<value> (required) Project id or key
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: description|name|releaseDate|sequence|startDate>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Search for project components. This command is only applicable to Jira Cloud
jira project-version update
Updates a project version.
USAGE
$ jira project-version update -i <value> [--name <value>] [--description <value>] [--startDate <value>] [--released]
[--releaseDate <value>] [--archived] [--moveUnfixedIssuesTo <value>]
FLAGS
-i, --id=<value> (required) Id of the version to be updated.
--[no-]archived Version is archived.
--description=<value> Description of version.
--moveUnfixedIssuesTo=<value> The URL of the self link to the version to which all unfixed issues are moved when a
version is released.
--name=<value> Name of version.
--releaseDate=<value> Release date of version.
--[no-]released Version is released.
--startDate=<value> Start date of version.
DESCRIPTION
Updates a project version.
jira project archive
Archive a project.
USAGE
$ jira project archive [-p <value>]
FLAGS
-p, --project=<value> Project id or key
DESCRIPTION
Archive a project.
jira project create
Create a new project.
USAGE
$ jira project create --key <value> --name <value> [--description <value>] [--url <value>] [--assigneeType
PROJECT_LEAD|UNASSIGNED] [--avatarId <value>] [--issueSecurityScheme <value>] [--permissionScheme <value>]
[--notificationScheme <value>] [--categoryId <value>] [--projectTypeKey software|service_desk|business]
[--projectTemplateKey <value>] [--lead <value> | --leadAccountId <value> | --leadUsername <value>]
FLAGS
--assigneeType=<option> The default assignee when creating issues for this project.
<options: PROJECT_LEAD|UNASSIGNED>
--avatarId=<value> An integer value for the project's avatar. Should be an already uploaded avatar's id.
--categoryId=<value> The ID of the project's category.
--description=<value> A brief description of the project.
--issueSecurityScheme=<value> The ID of the issue security scheme for the project, which enables you to control who
can and cannot view issues.
--key=<value> (required) Project keys must be unique and start with an uppercase letter followed by
one or more uppercase alphanumeric characters. The maximum length is 10 characters.
Required when creating a project. Optional when updating a project.
--lead=<value> The user name or accountId of the project lead. Can be used both server or cloud.
--leadAccountId=<value> The account ID of the project lead. Only applicable to cloud.
--leadUsername=<value> The user name of the project lead. Only applicable to server.
--name=<value> (required) The name of the project. Required when creating a project. Optional when
updating a project.
--notificationScheme=<value> The ID of the notification scheme for the project.
--permissionScheme=<value> The ID of the permission scheme for the project.
--projectTemplateKey=<value> A prebuilt configuration for a project. The type of the projectTemplateKey must match
with the type of the projectTypeKey.
--projectTypeKey=<option> The 'project type' (https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-
Productfeaturesandprojecttypes), which dictates the application-specific feature set.
<options: software|service_desk|business>
--url=<value> A link to information about this project, such as project documentation
DESCRIPTION
Create a new project.
jira project delete
Delete a project.
USAGE
$ jira project delete [-p <value>]
FLAGS
-p, --project=<value> Project id or key
DESCRIPTION
Delete a project.
jira project get [PROJECT]
Get details of a project.
USAGE
$ jira project get [PROJECT] [-p <value>]
ARGUMENTS
PROJECT Project ID or Key.
FLAGS
-p, --project=<value>... Project ID or Key.
DESCRIPTION
Get details of a project.
jira project get-all
Get list of all projects. For cloud consider using 'search' command instead of this one.
USAGE
$ jira project get-all [-r <value>] [-a]
FLAGS
-a, --includeArchived Also include archived projects.
-r, --recentProjects=<value> Only specified number of recent projects. max: 20
DESCRIPTION
Get list of all projects. For cloud consider using 'search' command instead of this one.
jira project get-all-issue-types
Get all statuses grouped by issue types.
USAGE
$ jira project get-all-issue-types [-p <value>]
FLAGS
-p, --project=<value> Project id or key
DESCRIPTION
Get all statuses grouped by issue types.
jira project get-issue-type-hierarchy
Get issue type hierarchy of a next gen project. Only for Cloud.
USAGE
$ jira project get-issue-type-hierarchy [-i <value> | ]
FLAGS
-i, --id=<value> project id
DESCRIPTION
Get issue type hierarchy of a next gen project. Only for Cloud.
jira project get-notification-schema
Gets notification schema of project.
USAGE
$ jira project get-notification-schema -p <value>
FLAGS
-p, --project=<value> (required) Project id or key
DESCRIPTION
Gets notification schema of project.
jira project project
Shows help about project commands
USAGE
$ jira project project
DESCRIPTION
Shows help about project commands
jira project restore
Restores a project from trash.
USAGE
$ jira project restore [-p <value>]
FLAGS
-p, --project=<value> Project id or key
DESCRIPTION
Restores a project from trash.
jira project search
Search for projects. This command is only applicable to Jira Cloud
USAGE
$ jira project search [--orderBy category|issueCount|key|lastIssueUpdatedTime|name|owner|archivedDate|deletedDate]
[--orderDirection ASC|DSC] [--search <value>] [--searchBy name|key] [--typeKey software|service_desk|business]
[--categoryId <value>] [--action view|edit|browse] [--status live|archived|deleted] [--all | --startAt <value> |
--maxResults <value>]
FLAGS
--action=<option> Actions that can be performed on a project.
<options: view|edit|browse>
--all Whether all responses are returned.
--categoryId=<value> category id.
--maxResults=<value> Maximum number of results to return.
--orderBy=<option> <options: category|issueCount|key|lastIssueUpdatedTime|name|owner|archivedDate|deletedDate>
--orderDirection=<option> <options: ASC|DSC>
--search=<value> search term. Use with searchBy.
--searchBy=<option> search by name or key
<options: name|key>
--startAt=<value> Start index of pagination.
--status=<option> Status of project.
<options: live|archived|deleted>
--typeKey=<option> The 'project type' (https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Prod
uctfeaturesandprojecttypes), which dictates the application-specific feature set.
<options: software|service_desk|business>
DESCRIPTION
Search for projects. This command is only applicable to Jira Cloud
jira project unarchive
Restore a project from archive.
USAGE
$ jira project unarchive [-p <value>]
FLAGS
-p, --project=<value> Project id or key
DESCRIPTION
Restore a project from archive.
jira project update
Updates the project.
USAGE
$ jira project update -p <value> [--newKey <value>] [--name <value>] [--description <value>] [--url <value>]
[--assigneeType PROJECT_LEAD|UNASSIGNED] [--avatarId <value>] [--issueSecurityScheme <value>] [--permissionScheme
<value>] [--notificationScheme <value>] [--categoryId <value>] [--lead <value> | --leadAccountId <value>]
FLAGS
-p, --project=<value> (required) Project id or key
--assigneeType=<option> The default assignee when creating issues for this project.
<options: PROJECT_LEAD|UNASSIGNED>
--avatarId=<value> An integer value for the project's avatar. Should be an already uploaded avatar's id.
--categoryId=<value> The ID of the project's category.
--description=<value> A brief description of the project.
--issueSecurityScheme=<value> The ID of the issue security scheme for the project, which enables you to control who
can and cannot view issues.
--lead=<value> The user name of the project lead.
--leadAccountId=<value> The account ID of the project lead.
--name=<value> The name of the project.
--newKey=<value> Project keys must be unique and start with an uppercase letter followed by one or more
uppercase alphanumeric characters. The maximum length is 10 characters.
--notificationScheme=<value> The ID of the notification scheme for the project.
--permissionScheme=<value> The ID of the permission scheme for the project.
--url=<value> A link to information about this project, such as project documentation
DESCRIPTION
Updates the project.
jira screen-scheme create
Creates a screen scheme.
USAGE
$ jira screen-scheme create -n <value> --defaultScreen <value> [--description <value>] [--editScreen <value>]
[--viewScreen <value>] [--createScreen <value>]
FLAGS
-n, --name=<value> (required) The name of the screen. The name must be unique.
--createScreen=<value> The ID of the create screen.
--defaultScreen=<value> (required) The ID of the default screen.
--description=<value> The description of the screen
--editScreen=<value> The ID of the edit screen.
--viewScreen=<value> The ID of the view screen.
DESCRIPTION
Creates a screen scheme.
jira screen-scheme delete
Deletes a screen scheme.
USAGE
$ jira screen-scheme delete -i <value>
FLAGS
-i, --screenId=<value> (required) The ID of the screen scheme.
DESCRIPTION
Deletes a screen scheme.
jira screen-scheme get-all
Gets all screen schemes. (Use the expanded flag to see screens of the schemes.)
USAGE
$ jira screen-scheme get-all [-i <value>] [--expand issueTypeScreenSchemes] [--orderBy id|name] [--orderDirection
ASC|DSC] [--query <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value>... The ID of screen scheme. You can provide multiple value by repeating this flag.
--all Whether all responses are returned.
--expand=<option> <options: issueTypeScreenSchemes>
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: id|name>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all screen schemes. (Use the expanded flag to see screens of the schemes.)
jira screen-scheme update
Updates a screen scheme.
USAGE
$ jira screen-scheme update -i <value> [-n <value>] [--description <value>] [--defaultScreen <value>] [--editScreen
<value>] [--viewScreen <value>] [--createScreen <value>]
FLAGS
-i, --screenSchemeId=<value> (required) The ID of the screen scheme.
-n, --name=<value> The name of the screen. The name must be unique.
--createScreen=<value> The ID of the create screen. To remove the screen association, pass a null.
--defaultScreen=<value> The ID of the default screen. To remove the screen association, pass a null.
--description=<value> The description of the screen.
--editScreen=<value> The ID of the edit screen. To remove the screen association, pass a null.
--viewScreen=<value> The ID of the view screen. To remove the screen association, pass a null.
DESCRIPTION
Updates a screen scheme.
jira screen-tab-field add
Adds a field to a screen tab.
USAGE
$ jira screen-tab-field add -i <value> --tabId <value> -i <value>
FLAGS
-i, --fieldId=<value> (required) The ID of the field to add.
-i, --screenId=<value> (required) The ID of screen.
--tabId=<value> (required) The ID of screen tab.
DESCRIPTION
Adds a field to a screen tab.
jira screen-tab-field get-all
Gets all fields for a screen tab.
USAGE
$ jira screen-tab-field get-all -i <value> --tabId <value> [--project <value>]
FLAGS
-i, --screenId=<value> (required) The ID of screen.
--project=<value> The key of the project.
--tabId=<value> (required) The ID of screen tab.
DESCRIPTION
Gets all fields for a screen tab.
jira screen-tab-field move
Moves a screen tab field.
USAGE
$ jira screen-tab-field move -i <value> --tabId <value> --fieldId <value> [-p Earlier|Later|First|Last] [-a <value>]
FLAGS
-a, --after=<value> The ID of the screen tab field after which to place the moved screen tab field.
-i, --screenId=<value> (required) The ID of screen.
-p, --position=<option> The position of tab. The base index is 0.
<options: Earlier|Later|First|Last>
--fieldId=<value> (required) The ID of the field.
--tabId=<value> (required) The ID of screen tab.
DESCRIPTION
Moves a screen tab field.
jira screen-tab-field remove
Removes a field from a screen tab.
USAGE
$ jira screen-tab-field remove -i <value> --tabId <value> --fieldId <value>
FLAGS
-i, --screenId=<value> (required) The ID of screen.
--fieldId=<value> (required) The ID of the field to add.
--tabId=<value> (required) The ID of screen tab.
DESCRIPTION
Removes a field from a screen tab.
jira screen-tab create
Creates a screen tab.
USAGE
$ jira screen-tab create -n <value> [-i <value>] [--description <value>]
FLAGS
-i, --id=<value> The ID of screen.
-n, --name=<value> (required) The name of the screen. The name must be unique.
--description=<value> The description of the screen
DESCRIPTION
Creates a screen tab.
jira screen-tab delete
Deletes a screen tab.
USAGE
$ jira screen-tab delete -i <value> --tabId <value>
FLAGS
-i, --screenId=<value> (required) The ID of screen.
--tabId=<value> (required) The ID of screen tab.
DESCRIPTION
Deletes a screen tab.
jira screen-tab get-all
Gets all screen tabs.
USAGE
$ jira screen-tab get-all -i <value> [-p <value>]
FLAGS
-i, --id=<value> (required) The ID of screen.
-p, --project=<value> The key of the project.
DESCRIPTION
Gets all screen tabs.
jira screen-tab move
Moves a screen tab.
USAGE
$ jira screen-tab move -i <value> --tabId <value> -p <value>
FLAGS
-i, --screenId=<value> (required) The ID of screen.
-p, --pos=<value> (required) The position of tab. The base index is 0.
--tabId=<value> (required) The ID of screen tab.
DESCRIPTION
Moves a screen tab.
jira screen-tab update
Updates a screen tab.
USAGE
$ jira screen-tab update -i <value> --tabId <value> -n <value>
FLAGS
-i, --screenId=<value> (required) The ID of screen.
-n, --name=<value> (required) The name of the screen. The name must be unique.
--tabId=<value> (required) The ID of screen tab.
DESCRIPTION
Updates a screen tab.
jira screen add-field-to-default-screen
Adds a field to the default tab of the default screen.
USAGE
$ jira screen add-field-to-default-screen -i <value>
FLAGS
-i, --fieldId=<value> (required) The ID of the field.
DESCRIPTION
Adds a field to the default tab of the default screen.
jira screen create
Creates a screen.
USAGE
$ jira screen create -n <value> [--description <value>]
FLAGS
-n, --name=<value> (required) The name of the screen. The name must be unique.
--description=<value> The description of the screen
DESCRIPTION
Creates a screen.
jira screen delete
Deletes a screen.
USAGE
$ jira screen delete -i <value>
FLAGS
-i, --screenId=<value> (required) The ID of the screen.
DESCRIPTION
Deletes a screen.
jira screen get-all
Gets all screens
USAGE
$ jira screen get-all [-i <value>] [--scope GLOBAL|PROJECT|TEMPLATE] [--expand <value>] [--orderBy id|name]
[--orderDirection ASC|DSC] [--query <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --id=<value>... The ID of screen. You can provide multiple value by repeating this flag.
--all Whether all responses are returned.
--expand=<value> fieldScreenSchemes,fieldScreenWorkflows, deletable
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--orderBy=<option> <options: id|name>
--orderDirection=<option> <options: ASC|DSC>
--query=<value> Filter the results using a literal string. This only works for Jira Cloud.
--scope=<option>... The scope filter string. You can provide multiple value by repeating this flag.
<options: GLOBAL|PROJECT|TEMPLATE>
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all screens
jira screen get-available-fields
Gets the fields that can be added to a tab on a screen.
USAGE
$ jira screen get-available-fields -i <value>
FLAGS
-i, --screenId=<value> (required) The ID of the screen.
DESCRIPTION
Gets the fields that can be added to a tab on a screen.
jira screen get-field-screens
Gets screens a field is used in.
USAGE
$ jira screen get-field-screens -i <value> [--expand tab] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-i, --fieldId=<value> (required) The ID of the field to return screens for.
--all Whether all responses are returned.
--expand=<option> This parameter accepts tab which returns details about the screen tabs the field is used in.
<options: tab>
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets screens a field is used in.
jira screen get-workflows
Gets all screens workflow.
USAGE
$ jira screen get-workflows [--startAt <value>] [--maxResults <value>]
FLAGS
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all screens workflow.
jira screen update
Updates a screen.
USAGE
$ jira screen update -i <value> [-n <value>] [--description <value>]
FLAGS
-i, --screenId=<value> (required) The ID of the screen.
-n, --name=<value> The name of the screen. The name must be unique.
--description=<value> The description of the screen
DESCRIPTION
Updates a screen.
jira server-info get
Returns general information about the current Jira.
USAGE
$ jira server-info get
DESCRIPTION
Returns general information about the current Jira.
jira server-info jmx
Returns JMX information from Jira VM.
USAGE
$ jira server-info jmx
DESCRIPTION
Returns JMX information from Jira VM.
jira status create
Creates status.
USAGE
$ jira status create -n <value> -c TODO|IN_PROGRESS|DONE -d <value> --scope GLOBAL|PROJECT [-p <value>]
FLAGS
-c, --statusCategory=<option> (required) Category of the status to filter by.
<options: TODO|IN_PROGRESS|DONE>
-d, --description=<value> (required) The description of the status.
-n, --name=<value> (required) The name of the status. Must be unique.
-p, --project=<value> Project Id or key. If the scope type is PROJECT, you must provide the project Id.
--scope=<option> (required) The scope of the status.
<options: GLOBAL|PROJECT>
DESCRIPTION
Creates status.
jira status delete [STATUSID]
Deletes statuses.
USAGE
$ jira status delete [STATUSID] [-i <value>]
ARGUMENTS
STATUSID Status ID.
FLAGS
-i, --id=<value>... Status ID.
DESCRIPTION
Deletes statuses.
jira status get [STATUSID]
Gets the statuses specified by one or more status IDs.
USAGE
$ jira status get [STATUSID] [-i <value>]
ARGUMENTS
STATUSID Status ID.
FLAGS
-i, --id=<value>... Status ID.
DESCRIPTION
Gets the statuses specified by one or more status IDs.
jira status get-usages
Gets usages of a status.
USAGE
$ jira status get-usages -i <value>
FLAGS
-i, --id=<value> (required) Status ID.
DESCRIPTION
Gets usages of a status.
jira status search
Searches statuses.
USAGE
$ jira status search [-q <value>] [-p <value>] [-i <value>] [-c TODO|IN_PROGRESS|DONE] [--all | --startAt <value>
| --maxResults <value>]
FLAGS
-c, --statusCategory=<option> Category of the status to filter by.
<options: TODO|IN_PROGRESS|DONE>
-i, --issueTypeId=<value>... The issue type Id to filter statuses. (Only server)
-p, --project=<value>... The project Id or key the status is part of or null for global statuses.
-q, --query=<value> The string that status names will be matched with.
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Searches statuses.
jira status status-command
USAGE
$ jira status status-command
jira status update
Updates a status.
USAGE
$ jira status update -i <value> [-n <value>] [-c TODO|IN_PROGRESS|DONE] [-d <value>]
FLAGS
-c, --statusCategory=<option> Category of the status to filter by.
<options: TODO|IN_PROGRESS|DONE>
-d, --description=<value> The description of the status.
-i, --id=<value> (required) Status Id.
-n, --name=<value> The name of the status. Must be unique.
DESCRIPTION
Updates a status.
jira task cancel
Cancels a task.
USAGE
$ jira task cancel --taskId <value>
FLAGS
--taskId=<value> (required) The ID of the task.
DESCRIPTION
Cancels a task.
jira task get [TASKID]
Gets the status of a long-running asynchronous task.
USAGE
$ jira task get [TASKID] [-i <value>]
ARGUMENTS
TASKID The ID of the task.
FLAGS
-i, --taskId=<value>... The ID of the task.
DESCRIPTION
Gets the status of a long-running asynchronous task.
jira time-tracking get
Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.
USAGE
$ jira time-tracking get
DESCRIPTION
Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a
successful but empty response is returned.
jira time-tracking get-all
Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking.
USAGE
$ jira time-tracking get-all
DESCRIPTION
Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time
tracking.
jira time-tracking get-setting
Returns the time tracking settings. This includes settings such as the time format, default time unit, and others.
USAGE
$ jira time-tracking get-setting
DESCRIPTION
Returns the time tracking settings. This includes settings such as the time format, default time unit, and others.
jira time-tracking select
Selects a time tracking provider.
USAGE
$ jira time-tracking select -k <value> [--name <value>]
FLAGS
-k, --key=<value> (required) The key for the time tracking provider. For example, JIRA.
--name=<value> The name of the time tracking provider. For example, JIRA provided time tracking.
DESCRIPTION
Selects a time tracking provider.
jira time-tracking set
Sets the time tracking settings.
USAGE
$ jira time-tracking set -H <value> -d <value> -t pretty|days|hours -u minute|hour|week|day
FLAGS
-H, --workingHoursPerDay=<value> (required) The number of hours in a working day. Example usage -h=12
-d, --workingDaysPerWeek=<value> (required) The number of days in a working week. Example usage -d=13
-t, --timeFormat=<option> (required) The format that will appear on an issue's Time Spent field. Example
usage: -t=pretty
<options: pretty|days|hours>
-u, --defaultUnit=<option> (required) The default unit of time applied to logged time. Example usage -u=day
<options: minute|hour|week|day>
DESCRIPTION
Sets the time tracking settings.
jira update [CHANNEL]
update the jira CLI
USAGE
$ jira update [CHANNEL] [--from-local]
FLAGS
--from-local interactively choose an already installed version
DESCRIPTION
update the jira CLI
See code: @oclif/plugin-update
jira user-property delete
Deletes a property from a user.
USAGE
$ jira user-property delete -k <value> [--userKey <value> | -u <value>]
FLAGS
-k, --key=<value> (required) The key of the user's property.
-u, --user=<value> Username for Server/DC and accountId or username or email for Cloud
--userKey=<value> The user key. Only applicable to server.
DESCRIPTION
Deletes a property from a user.
jira user-property get-all-keys
Returns the keys of all properties for a user.
USAGE
$ jira user-property get-all-keys [--userKey <value> | -u <value>]
FLAGS
-u, --user=<value> Username for Server/DC and accountId or username or email for Cloud
--userKey=<value> The user key. Only applicable to server.
DESCRIPTION
Returns the keys of all properties for a user.
jira user-property get-user-property
Returns the value of a user's property. If no property key is provided Get user property keys is called.
USAGE
$ jira user-property get-user-property -k <value> [--userKey <value> | -u <value>]
FLAGS
-k, --key=<value> (required) The key of the user's property.
-u, --user=<value> Username for Server/DC and accountId or username or email for Cloud
--userKey=<value> The user key. Only applicable to server.
DESCRIPTION
Returns the value of a user's property. If no property key is provided Get user property keys is called.
jira user-property set [VALUE]
Sets the value of a user's property.
USAGE
$ jira user-property set [VALUE] -k <value> -v <value> [--userKey <value> | -u <value>]
ARGUMENTS
VALUE The value of the user's property.
FLAGS
-k, --key=<value> (required) The key of the user's property.
-u, --user=<value> Username for Server/DC and accountId or username or email for Cloud
-v, --value=<value> (required) The value of the user's property.
--userKey=<value> The user key. Only applicable to server.
DESCRIPTION
Sets the value of a user's property.
jira user-search accounts-with-query
Finds account IDs with a structured query.
USAGE
$ jira user-search accounts-with-query --search <value> [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--search=<value> (required) The search string. Ex: is assignee of PROJ
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Finds account IDs with a structured query.
jira user-search assignable-users
Returns a list of users that match the search string. Call with an issue key when a list of assignable users is retrieved for editing. For create only a project key should be supplied.
USAGE
$ jira user-search assignable-users [--startAt <value>] [--maxResults <value>] [--search <value>] [--actionDescriptorId <value>]
[--project <value> | --issue <value>]
FLAGS
--actionDescriptorId=<value> The ID of the workflow transition.
--issue=<value> The issue key for the issue being edited we need to find assignable users for.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--project=<value> The key of the projects we are finding assignable users for.
--search=<value> The search string.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Returns a list of users that match the search string. Call with an issue key when a list of assignable users is
retrieved for editing. For create only a project key should be supplied.
jira user-search assignable-users-bulk
Returns a list of users that match the search string and can be assigned issues for all the given projects.
USAGE
$ jira user-search assignable-users-bulk --project <value> [--startAt <value>] [--maxResults <value>] [--search
<value>]
FLAGS
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--project=<value>... (required) The key of the projects we are finding assignable users for.
--search=<value> The search string.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Returns a list of users that match the search string and can be assigned issues for all the given projects.
jira user-search find
Returns a list of users that match the search string. This resource cannot be accessed anonymously.
USAGE
$ jira user-search find --search <value> [--startAt <value>] [--maxResults <value>] [--property <value>]
[--includeActive] [--includeInActive]
FLAGS
--[no-]includeActive Applicable to only Server and DC. If true, then active users are included in the results
(default true).
--[no-]includeInActive Applicable to only Server and DC. If true, then inactive users are included in the results
(default false).
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--property=<value> Applicable to only Cloud. A query string used to search properties. To search for the value of
nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1.
--search=<value> (required) The search string.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Returns a list of users that match the search string. This resource cannot be accessed anonymously.
jira user-search with-permission
Returns a list of active users that match the search string and have all specified permissions for the project or issue.
USAGE
$ jira user-search with-permission -p <value> [--startAt <value>] [--maxResults <value>] [--search <value>] [-i <value>]
[--project <value>]
FLAGS
-i, --issue=<value> The issue key for the issue for which returned users have specified permissions.
-p, --permission=<value>... (required) Permission key. This flag can be repeated.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--project=<value> The optional project key to search for users with if no issueKey is supplied.
--search=<value> The search string.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Returns a list of active users that match the search string and have all specified permissions for the project or
issue.
jira user-search with-query
Finds users with a structured query and returns a paginated list of user details.
USAGE
$ jira user-search with-query --search <value> [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--search=<value> (required) The search string. Ex: is assignee of PROJ
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Finds users with a structured query and returns a paginated list of user details.
jira user add-user-to-application
Returns a user.
USAGE
$ jira user add-user-to-application --user <value> [--applicationKey jira-core|jira-software|jira-servicedesk]
FLAGS
--applicationKey=<option>... The application key. Only applicable to server. This parameter can be repeated.
<options: jira-core|jira-software|jira-servicedesk>
--user=<value> (required) The username.
DESCRIPTION
Returns a user.
jira user change-password
Modify user password.
USAGE
$ jira user change-password [--userKey <value> | | --username <value>] [--password <value>]
FLAGS
--password=<value> New password for the user. Requires administration permission.
--userKey=<value> The user key. Only applicable to server.
--username=<value> The username. Only applicable to server.
DESCRIPTION
Modify user password.
jira user create
Creates a user.
USAGE
$ jira user create --displayName <value> --emailAddress <value> [--notification] [--password <value>]
[--username <value>]
FLAGS
--displayName=<value> (required) The display name for the user.
--emailAddress=<value> (required) The email address for the user.
--[no-]notification Sends the user an email confirmation that they have been added to Jira. Default is false.
--password=<value> A password for the user. If a password is not set, a random password is generated.
--username=<value> The username. Only applicable to server and required.
DESCRIPTION
Creates a user.
jira user delete
Deletes a user.
USAGE
$ jira user delete (--userKey <value> | --user <value>)
FLAGS
--user=<value> (required) Username for Server/DC and accountId or username or email for Cloud
--userKey=<value> The user key. Only applicable to server.
DESCRIPTION
Deletes a user.
jira user get [USER]
Returns a user.
USAGE
$ jira user get [USER] [--userKey <value> | --accountId <value> | --username <value>] [-u <value>]
ARGUMENTS
USER The account ID or username or email of the user, which uniquely identifies the user across all Atlassian
products. Only applicable to cloud.
FLAGS
-u, --user=<value>... The account ID or email or username of the user, which uniquely identifies the user across all
Atlassian products. Only applicable to cloud.
--accountId=<value> The account ID of the user, which uniquely identifies the user across all Atlassian products.
Only applicable to cloud.
--userKey=<value> The user key. Only applicable to server.
--username=<value> The username. Only applicable to server.
DESCRIPTION
Returns a user.
jira user get-all
Returns a paginated list of the users. If you specify one or more accountId only those users will be returned.
USAGE
$ jira user get-all [--user <value>] [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
--user=<value>... The account ID or email or username of the user, which uniquely identifies the user across all
Atlassian products. Only applicable to cloud.
DESCRIPTION
Returns a paginated list of the users. If you specify one or more accountId only those users will be returned.
jira user get-default-columns [USER]
Returns the default issue table columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
USAGE
$ jira user get-default-columns [USER] [--user <value>]
ARGUMENTS
USER Username or accountId or email.
FLAGS
--user=<value>... Username for Server/DC and accountId or username or email for Cloud
DESCRIPTION
Returns the default issue table columns for the given user. Admin permission will be required to get columns for a
user other than the currently logged in user.
jira user get-email [USER]
Returns a user's email address.
USAGE
$ jira user get-email [USER] [--user <value>]
ARGUMENTS
USER The account ID of the user, which uniquely identifies the user across all Atlassian products. Only applicable to
cloud.
FLAGS
--user=<value>... AccountId or username or email for Cloud.
DESCRIPTION
Returns a user's email address.
jira user get-user-groups [USER]
Returns the groups to which a user belongs.
USAGE
$ jira user get-user-groups [USER] [--user <value>]
ARGUMENTS
USER The account ID of the user, which uniquely identifies the user across all Atlassian products. Only applicable to
cloud.
FLAGS
--user=<value>... AccountId or username or email for Cloud.
DESCRIPTION
Returns the groups to which a user belongs.
jira user remove-user-from-application
Returns a user.
USAGE
$ jira user remove-user-from-application --username <value> [--applicationKey
jira-core|jira-software|jira-servicedesk]
FLAGS
--applicationKey=<option>... The application key. Only applicable to server. This parameter can be repeated.
<options: jira-core|jira-software|jira-servicedesk>
--username=<value> (required) The username.
DESCRIPTION
Returns a user.
jira user reset-default-columns [USER]
Reset the default columns for the given user to the system default. Admin permission will be required to get columns for a user other than the currently logged in user.
USAGE
$ jira user reset-default-columns [USER] [--user <value>]
ARGUMENTS
USER Username or accountId
FLAGS
--user=<value>... Username for Server/DC and accountId or username or email for Cloud
DESCRIPTION
Reset the default columns for the given user to the system default. Admin permission will be required to get columns
for a user other than the currently logged in user.
jira user set-default-columns
Sets the default issue table columns. Admin permission will be required to set columns for a user other than the currently logged in user.
USAGE
$ jira user set-default-columns -c <value> [--user <value>]
FLAGS
-c, --columnKey=<value>... (required) The key of column. You can repeat this flag for setting multiple columns.
--user=<value>... Username for Server/DC and accountId or username or email for Cloud
DESCRIPTION
Sets the default issue table columns. Admin permission will be required to set columns for a user other than the
currently logged in user.
jira user update
Updates a user.
USAGE
$ jira user update --displayName <value> --emailAddress <value> [--notification] [--password <value>]
[--username <value>] [--userKey <value>] [--active] [--applicationKey jira-core|jira-software|jira-servicedesk]
FLAGS
--[no-]active Whether the user is active or inactive. Default true. Only applicable to server.
--applicationKey=<option>... The application key. Only applicable to server. This parameter can be repeated.
<options: jira-core|jira-software|jira-servicedesk>
--displayName=<value> (required) The display name for the user.
--emailAddress=<value> (required) The email address for the user.
--[no-]notification Sends the user an email confirmation that they have been added to Jira. Default is
false.
--password=<value> A password for the user. If a password is not set, a random password is generated.
--userKey=<value> The userKey. Only applicable to server and required.
--username=<value> The username. Only applicable to server and required.
DESCRIPTION
Updates a user.
jira user user-command
USAGE
$ jira user user-command
jira workflow-scheme-draft create
Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.
USAGE
$ jira workflow-scheme-draft create -i <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the active workflow scheme that the draft was created from.
DESCRIPTION
Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an
active workflow scheme can only have one draft workflow scheme.
jira workflow-scheme-draft delete
Deletes a draft workflow scheme.
USAGE
$ jira workflow-scheme-draft delete -i <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the active workflow scheme that the draft was created from.
DESCRIPTION
Deletes a draft workflow scheme.
jira workflow-scheme-draft delete-default-workflow
Deletes default workflow of a workflow scheme.
USAGE
$ jira workflow-scheme-draft delete-default-workflow -i <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
DESCRIPTION
Deletes default workflow of a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be
published in Jira.
jira workflow-scheme-draft delete-issue-types-for-workflow
Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
USAGE
$ jira workflow-scheme-draft delete-issue-types-for-workflow -i <value> --workflow <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
--workflow=<value> (required) The name of the workflow.
DESCRIPTION
Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow
scheme can be published in Jira.
jira workflow-scheme-draft delete-workflow-for-issue-type
Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
USAGE
$ jira workflow-scheme-draft delete-workflow-for-issue-type -i <value> --issueType <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
--issueType=<value> (required) The ID of the issue type.
DESCRIPTION
Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow
scheme can be published in Jira.
jira workflow-scheme-draft get [WORKFLOWSCHEMEID]
Gets the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme.
USAGE
$ jira workflow-scheme-draft get [WORKFLOWSCHEMEID] [-i <value>]
ARGUMENTS
WORKFLOWSCHEMEID The ID of the active workflow scheme that the draft was created from.
FLAGS
-i, --workflowSchemeId=<value>... The ID of the active workflow scheme that the draft was created from.
DESCRIPTION
Gets the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the
active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified,
then the changes in the draft are copied back to the active workflow scheme.
jira workflow-scheme-draft get-default-workflow
Gets default workflow of workflow scheme.
USAGE
$ jira workflow-scheme-draft get-default-workflow -i <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
DESCRIPTION
Gets default workflow of workflow scheme.
jira workflow-scheme-draft get-issue-types-for-workflows
Gets the workflow-issue type mappings for a workflow scheme draft.
USAGE
$ jira workflow-scheme-draft get-issue-types-for-workflows -i <value> [--workflowName <value>]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
--workflowName=<value> The name of a workflow in the scheme. Limits the results to the workflow-issue type
mapping for the specified workflow
DESCRIPTION
Gets the workflow-issue type mappings for a workflow scheme draft.
jira workflow-scheme-draft get-workflow-for-issue-type
Gets the issue type-workflow mapping for an issue type in a workflow scheme draft.
USAGE
$ jira workflow-scheme-draft get-workflow-for-issue-type -i <value> --issueType <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
--issueType=<value> (required) The ID of the issue type.
DESCRIPTION
Gets the issue type-workflow mapping for an issue type in a workflow scheme draft.
jira workflow-scheme-draft publish
Publishes a draft workflow scheme. Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status. This operation is asynchronous. You can use jira task:get
command to obtain any updates.
USAGE
$ jira workflow-scheme-draft publish -i <value> [--validateOnly] [--statusMappings <value>] [--silent]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the active workflow scheme that the draft was created from.
--silent If you activate this flag progress bar will not be shown.
--statusMappings=<value>... Mappings of statuses to new statuses for issue types. You can provide multiple values
by repeating this flag. KEYS: [statusId, newStatusId, issueTypeId]
Example use case: --statusMappings=statusId=10000,issueTypeId=10000,newStatusId=10000
--validateOnly Whether the request only performs a validation.
DESCRIPTION
Publishes a draft workflow scheme. Where the draft workflow includes new workflow statuses for an issue type, mappings
are provided to update issues with the original workflow status to the new workflow status. This operation is
asynchronous. You can use `jira task:get` command to obtain any updates.
jira workflow-scheme-draft set-issue-types-for-workflow
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.
USAGE
$ jira workflow-scheme-draft set-issue-types-for-workflow -i <value> --issueTypes <value> --workflow <value>
[--defaultMapping] [--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
--defaultMapping Whether the workflow is the default workflow for the workflow scheme.
--issueTypes=<value> (required) The list of issue type IDs. Please separete values with comma. Example
Usage --issueTypes=10000,10001
--updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and update the mapping
in the draft, when the workflow scheme cannot be edited. Defaults to false. Only
applicable when updating the workflow-issue types mapping.
--workflow=<value> (required) The name of the workflow.
DESCRIPTION
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the
workflow scheme. Unmapped issues types are mapped to the default workflow.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The
draft workflow scheme can be published in Jira.
jira workflow-scheme-draft set-workflow-for-issue-type
Sets the workflow for an issue type in a workflow scheme draft.
USAGE
$ jira workflow-scheme-draft set-workflow-for-issue-type -i <value> --issueType <value> [--workflow <value>]
[--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
--issueType=<value> (required) The ID of the issue type.
--updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and update the mapping
in the draft, when the workflow scheme cannot be edited. Defaults to false. Only
applicable when updating the workflow-issue types mapping.
--workflow=<value> The name of the workflow.
DESCRIPTION
Sets the workflow for an issue type in a workflow scheme draft.
jira workflow-scheme-draft update [WORKFLOWSCHEMEBODY]
Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme. You can also provide request body as JSON using STDIN without specifying any flags.
USAGE
$ jira workflow-scheme-draft update [WORKFLOWSCHEMEBODY] -i <value> [-n <value>] [--description <value>] [--issueTypeMappings
<value>] [--updateDraftIfNeeded] [--defaultWorkflow <value>] [--show]
ARGUMENTS
WORKFLOWSCHEMEBODY Workflow scheme update request in JSON format.
FLAGS
-i, --workflowSchemeId=<value>
(required) The ID of the active workflow scheme that the draft was created from.
-n, --name=<value>
The name of the workflow scheme.
--defaultWorkflow=<value>
The name of the default workflow for the workflow scheme.
--description=<value>
The description of the workflow scheme.
--issueTypeMappings=<value>
The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an
issue type can only be mapped to one workflow in a workflow scheme.
Example usage: --issueTypeMappings=issueTypeId=WorkflowName,issueTypeId2=WorkflowName2
--show
Prepare a sample JSON output for workflow scheme update.
--updateDraftIfNeeded
Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow
scheme is a workflow scheme that is used by at least one project. The following examples show how this property
works:
• Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is
updated. Otherwise, a draft workflow scheme is created.
• Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow
schemes cannot be updated.
• Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as
inactive workflow schemes do not require drafts to update.
DESCRIPTION
Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a
draft is created. Note that an active workflow scheme can only have one draft workflow scheme. You can also provide
request body as JSON using STDIN without specifying any flags.
jira workflow-scheme-draft update-default-workflow
Updates default workflow of a workflow scheme.
USAGE
$ jira workflow-scheme-draft update-default-workflow -i <value> -w <value> [--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme that the draft belongs to.
-w, --workflow=<value> (required) The name of the workflow to set as the default workflow
--updateDraftIfNeeded Whether a draft workflow scheme is created or updated when updating an active workflow
scheme. The draft is updated with the new default workflow
DESCRIPTION
Updates default workflow of a workflow scheme.
jira workflow-scheme-project-association assign
Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.
USAGE
$ jira workflow-scheme-project-association assign [-p <value>] [--workflowSchemeId <value>]
FLAGS
-p, --project=<value> The ID or key of the project.
--workflowSchemeId=<value> The ID of the workflow scheme. If the workflow scheme ID is null, the operation assigns
the default workflow scheme.
DESCRIPTION
Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.
jira workflow-scheme-project-association get-all
Gets a list of the workflow schemes associated with a list of projects
USAGE
$ jira workflow-scheme-project-association get-all -p <value>
FLAGS
-p, --project=<value>... (required) The ID of a project to return the workflow schemes for. You can provide multiple
values by repeating this flag.
DESCRIPTION
Gets a list of the workflow schemes associated with a list of projects
jira workflow-scheme create [WORKFLOWSCHEMEBODY]
Creates workflow scheme. You can also provide request body as JSON using STDIN without specifying any flags.
USAGE
$ jira workflow-scheme create [WORKFLOWSCHEMEBODY] [-n <value>] [--description <value>] [--issueTypeMappings <value>]
[--updateDraftIfNeeded] [--defaultWorkflow <value>] [--show]
ARGUMENTS
WORKFLOWSCHEMEBODY Workflow scheme creation request in JSON format.
FLAGS
-n, --name=<value>
The name of the workflow scheme. (Required)
--defaultWorkflow=<value>
The name of the default workflow for the workflow scheme.
--description=<value>
The description of the workflow scheme.
--issueTypeMappings=<value>
The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an
issue type can only be mapped to one workflow in a workflow scheme.
Example usage: --issueTypeMappings=issueTypeId=WorkflowName,issueTypeId2=WorkflowName2
--show
Prepare a sample JSON output for workflow scheme creation.
--updateDraftIfNeeded
Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow
scheme is a workflow scheme that is used by at least one project. The following examples show how this property
works:
• Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is
updated. Otherwise, a draft workflow scheme is created.
• Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow
schemes cannot be updated.
• Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as
inactive workflow schemes do not require drafts to update.
DESCRIPTION
Creates workflow scheme. You can also provide request body as JSON using STDIN without specifying any flags.
jira workflow-scheme delete
Deletes a workflow scheme.
USAGE
$ jira workflow-scheme delete -i <value>
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
DESCRIPTION
Deletes a workflow scheme.
jira workflow-scheme delete-default-workflow
Deletes default workflow of a workflow scheme.
USAGE
$ jira workflow-scheme delete-default-workflow -i <value> [--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and delete the mapping
from the draft, when the workflow scheme cannot be edited.
DESCRIPTION
Deletes default workflow of a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be
published in Jira.
jira workflow-scheme delete-issue-types-for-workflow
Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
USAGE
$ jira workflow-scheme delete-issue-types-for-workflow -i <value> --workflow <value> [--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and delete the mapping
from the draft, when the workflow scheme cannot be edited.
--workflow=<value> (required) The name of the workflow.
DESCRIPTION
Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow
scheme can be published in Jira.
jira workflow-scheme delete-workflow-for-issue-type
Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
USAGE
$ jira workflow-scheme delete-workflow-for-issue-type -i <value> --issueType <value> [--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--issueType=<value> (required) The ID of the issue type.
--updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and delete the mapping
from the draft, when the workflow scheme cannot be edited.
DESCRIPTION
Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow
scheme can be published in Jira.
jira workflow-scheme get [WORKFLOWSCHEMEID]
Gets a workflow scheme.
USAGE
$ jira workflow-scheme get [WORKFLOWSCHEMEID] [-i <value>] [--returnDraftIfExists]
ARGUMENTS
WORKFLOWSCHEMEID The ID of the workflow scheme.
FLAGS
-i, --workflowSchemeId=<value>... The ID of the workflow scheme.
--returnDraftIfExists Returns the workflow scheme's draft rather than scheme itself, if set to true. If
the workflow scheme does not have a draft, then the workflow scheme is returned
DESCRIPTION
Gets a workflow scheme.
jira workflow-scheme get-all
Gets all workflow schemes.
USAGE
$ jira workflow-scheme get-all [--all | --startAt <value> | --maxResults <value>]
FLAGS
--all Whether all responses are returned.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
DESCRIPTION
Gets all workflow schemes.
jira workflow-scheme get-default-workflow
Gets default workflow of workflow scheme.
USAGE
$ jira workflow-scheme get-default-workflow -i <value> [--returnDraftIfExists]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--returnDraftIfExists Returns the workflow scheme's draft rather than scheme itself, if set to true. If the
workflow scheme does not have a draft, then the workflow scheme is returned
DESCRIPTION
Gets default workflow of workflow scheme.
jira workflow-scheme get-issue-types-for-workflows
Gets the workflow-issue type mappings for a workflow scheme.
USAGE
$ jira workflow-scheme get-issue-types-for-workflows -i <value> [--workflowName <value>] [--returnDraftIfExists]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--returnDraftIfExists Returns the workflow scheme's draft rather than scheme itself, if set to true. If the
workflow scheme does not have a draft, then the workflow scheme is returned
--workflowName=<value> The name of a workflow in the scheme. Limits the results to the workflow-issue type
mapping for the specified workflow
DESCRIPTION
Gets the workflow-issue type mappings for a workflow scheme.
jira workflow-scheme get-workflow-for-issue-type
Gets the issue type-workflow mapping for an issue type in a workflow scheme.
USAGE
$ jira workflow-scheme get-workflow-for-issue-type -i <value> --issueType <value> [--returnDraftIfExists]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--issueType=<value> (required) The ID of the issue type.
--returnDraftIfExists Returns the workflow scheme's draft rather than scheme itself, if set to true. If the
workflow scheme does not have a draft, then the workflow scheme is returned
DESCRIPTION
Gets the issue type-workflow mapping for an issue type in a workflow scheme.
jira workflow-scheme set-issue-types-for-workflow
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.
USAGE
$ jira workflow-scheme set-issue-types-for-workflow -i <value> --issueTypes <value> --workflow <value>
[--defaultMapping] [--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--defaultMapping Whether the workflow is the default workflow for the workflow scheme.
--issueTypes=<value> (required) The list of issue type IDs. Please separete values with comma. Example
Usage --issueTypes=10000,10001
--updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and update the mapping
in the draft, when the workflow scheme cannot be edited. Defaults to false. Only
applicable when updating the workflow-issue types mapping.
--workflow=<value> (required) The name of the workflow.
DESCRIPTION
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the
workflow scheme. Unmapped issues types are mapped to the default workflow.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The
draft workflow scheme can be published in Jira.
jira workflow-scheme set-workflow-for-issue-type
Sets the workflow for an issue type in a workflow scheme.
USAGE
$ jira workflow-scheme set-workflow-for-issue-type -i <value> --issueType <value> [--workflow <value>]
[--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
--issueType=<value> (required) The ID of the issue type.
--updateDraftIfNeeded Set to true to create or update the draft of a workflow scheme and update the mapping
in the draft, when the workflow scheme cannot be edited. Defaults to false. Only
applicable when updating the workflow-issue types mapping.
--workflow=<value> The name of the workflow.
DESCRIPTION
Sets the workflow for an issue type in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true
in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The
draft workflow scheme can be published in Jira.
jira workflow-scheme update [WORKFLOWSCHEMEBODY]
Updates workflow scheme. You can also provide request body as JSON using STDIN without specifying any flags.
USAGE
$ jira workflow-scheme update [WORKFLOWSCHEMEBODY] -i <value> [-n <value>] [--description <value>] [--issueTypeMappings
<value>] [--updateDraftIfNeeded] [--defaultWorkflow <value>] [--show]
ARGUMENTS
WORKFLOWSCHEMEBODY Workflow scheme update request in JSON format.
FLAGS
-i, --workflowSchemeId=<value>
(required) The ID of the workflow scheme.
-n, --name=<value>
The name of the workflow scheme.
--defaultWorkflow=<value>
The name of the default workflow for the workflow scheme.
--description=<value>
The description of the workflow scheme.
--issueTypeMappings=<value>
The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an
issue type can only be mapped to one workflow in a workflow scheme.
Example usage: --issueTypeMappings=issueTypeId=WorkflowName,issueTypeId2=WorkflowName2
--show
Prepare a sample JSON output for workflow scheme update.
--updateDraftIfNeeded
Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow
scheme is a workflow scheme that is used by at least one project. The following examples show how this property
works:
• Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is
updated. Otherwise, a draft workflow scheme is created.
• Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow
schemes cannot be updated.
• Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as
inactive workflow schemes do not require drafts to update.
DESCRIPTION
Updates workflow scheme. You can also provide request body as JSON using STDIN without specifying any flags.
jira workflow-scheme update-default-workflow
Updates default workflow of a workflow scheme.
USAGE
$ jira workflow-scheme update-default-workflow -i <value> -w <value> [--updateDraftIfNeeded]
FLAGS
-i, --workflowSchemeId=<value> (required) The ID of the workflow scheme.
-w, --workflow=<value> (required) The name of the workflow to set as the default workflow
--updateDraftIfNeeded Whether a draft workflow scheme is created or updated when updating an active workflow
scheme. The draft is updated with the new default workflow
DESCRIPTION
Updates default workflow of a workflow scheme.
jira workflow-status-category get
Gets a status category. Status categories provided a mechanism for categorizing statuses.
USAGE
$ jira workflow-status-category get --idOrName <value>
FLAGS
--idOrName=<value> (required) The ID or name of the status.
DESCRIPTION
Gets a status category. Status categories provided a mechanism for categorizing statuses.
jira workflow-status-category get-all
Gets a all status categories.
USAGE
$ jira workflow-status-category get-all
DESCRIPTION
Gets a all status categories.
jira workflow-status get [IDORNAME]
Gets a status. The status must be associated with an active workflow to be returned. If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable. This operation can be accessed anonymously.
USAGE
$ jira workflow-status get [IDORNAME] [--idOrName <value>]
ARGUMENTS
IDORNAME The ID or name of the status.
FLAGS
--idOrName=<value>... The ID or name of the status.
DESCRIPTION
Gets a status. The status must be associated with an active workflow to be returned. If a name is used on more than
one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.
This operation can be accessed anonymously.
jira workflow-status get-all
Gets all statuses associated with active workflows.
USAGE
$ jira workflow-status get-all
DESCRIPTION
Gets all statuses associated with active workflows.
jira workflow-transition-property create
Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition.
USAGE
$ jira workflow-transition-property create -i <value> -n <value> -k <value> --value <value> [--workflowMode
live|draft]
FLAGS
-i, --transitionId=<value> (required) The ID of the transition. To get the ID, view the workflow in text mode in the
Jira administration console. The ID is shown next to the transition.
-k, --key=<value> (required) The key of the property being added, also known as the name of the property.
-n, --workflowName=<value> (required) The name of the workflow that the transition belongs to.
--value=<value> (required) The value of the transition property.
--workflowMode=<option> [default: live] The workflow status. Set to live for inactive workflows or draft for draft
workflows. Active workflows cannot be edited.
<options: live|draft>
DESCRIPTION
Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition.
jira workflow-transition-property delete
Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition.
USAGE
$ jira workflow-transition-property delete -i <value> -n <value> -k <value> [--workflowMode live|draft]
FLAGS
-i, --transitionId=<value> (required) The ID of the transition. To get the ID, view the workflow in text mode in the
Jira administration console. The ID is shown next to the transition.
-k, --key=<value> (required) The name of the transition property to delete, also known as the name of the
property.
-n, --workflowName=<value> (required) The name of the workflow that the transition belongs to.
--workflowMode=<option> [default: live] The workflow status. Set to live for active and inactive workflows, or
draft for draft workflows.
<options: live|draft>
DESCRIPTION
Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition.
jira workflow-transition-property get
Gets properties on a workflow transition. Transition properties are used to change the behavior of a transition.
USAGE
$ jira workflow-transition-property get -i <value> -n <value> [--workflowMode live|draft] [-k <value>]
[--includeReservedKeys]
FLAGS
-i, --transitionId=<value> (required) The ID of the transition. To get the ID, view the workflow in text mode in the
Jira administration console. The ID is shown next to the transition.
-k, --key=<value> The key of the property being returned, also known as the name of the property. If this
parameter is not specified, all properties on the transition are returned.
-n, --workflowName=<value> (required) The name of the workflow that the transition belongs to.
--includeReservedKeys Some properties with keys that have the jira. prefix are reserved, which means they are
not editable. To include these properties in the results, set this parameter to true.
--workflowMode=<option> [default: live] The workflow status. Set to live for active and inactive workflows, or
draft for draft workflows.
<options: live|draft>
DESCRIPTION
Gets properties on a workflow transition. Transition properties are used to change the behavior of a transition.
jira workflow-transition-property update
Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition.
USAGE
$ jira workflow-transition-property update -i <value> -n <value> -k <value> --value <value> [--workflowMode
live|draft]
FLAGS
-i, --transitionId=<value> (required) The ID of the transition. To get the ID, view the workflow in text mode in the
Jira administration console. The ID is shown next to the transition.
-k, --key=<value> (required) The key of the property being added, also known as the name of the property.
-n, --workflowName=<value> (required) The name of the workflow that the transition belongs to.
--value=<value> (required) The value of the transition property.
--workflowMode=<option> [default: live] The workflow status. Set to live for inactive workflows or draft for draft
workflows. Active workflows cannot be edited.
<options: live|draft>
DESCRIPTION
Updates a workflow transition by changing the property value. Trying to update a property that does not exist results
in a new property being added to the transition.
jira workflow create [WORKFLOWBODY]
Creates workflow.
USAGE
$ jira workflow create [WORKFLOWBODY] [--workflowBody <value>]
ARGUMENTS
WORKFLOWBODY Workflow creation request in JSON format.
FLAGS
--workflowBody=<value> Workflow creation request in JSON format. You can get more details in https://developer.atlass
ian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflow-post
DESCRIPTION
Creates workflow.
jira workflow delete
Deletes inactive workflow.
USAGE
$ jira workflow delete -i <value>
FLAGS
-i, --entityId=<value> (required) The entity ID of the workflow.
DESCRIPTION
Deletes inactive workflow.
jira workflow get-projects
Gets information about the projects the workflow is assigned to, through workflow schemes.
USAGE
$ jira workflow get-projects -n <value>
FLAGS
-n, --workflowName=<value> (required) The name of the workflow that the transitions belongs to.
DESCRIPTION
Gets information about the projects the workflow is assigned to, through workflow schemes.
jira workflow get-schemes
Gets information about the workflow schemes the workflow is assigned to.
USAGE
$ jira workflow get-schemes -n <value>
FLAGS
-n, --workflowName=<value> (required) The name of the workflow that the transitions belongs to.
DESCRIPTION
Gets information about the workflow schemes the workflow is assigned to.
jira workflow get-statuses
Gets information about the statuses inside the workflow
USAGE
$ jira workflow get-statuses -n <value>
FLAGS
-n, --workflowName=<value> (required) The name of the workflow that the transitions belongs to.
DESCRIPTION
Gets information about the statuses inside the workflow
jira workflow get-statuses-properties
For each workflow status, gets information about its properties.
USAGE
$ jira workflow get-statuses-properties -n <value> [--statusIds <value>]
FLAGS
-n, --workflowName=<value> (required) The name of the workflow that the transitions belongs to.
--statusIds=<value> Workflow's status Id. You can provide multiple Ids by separeting them with comma to filter
the statuses.
Example usage: statusIds=1,2,4
DESCRIPTION
For each workflow status, gets information about its properties.
jira workflow get-transitions
Gets given workflow's transitions
USAGE
$ jira workflow get-transitions -n <value>
FLAGS
-n, --workflowName=<value> (required) The name of the workflow that the transitions belongs to.
DESCRIPTION
Gets given workflow's transitions
jira workflow get-transitions-rules
Gets given workflow's transition rules
USAGE
$ jira workflow get-transitions-rules [-n <value>] [--transitionIds <value>] [--ruleType
conditionsTree|validators|postFunctions]
FLAGS
-n, --workflowName=<value> The name of the workflow that the transition rules belongs to.
--ruleType=<option> <options: conditionsTree|validators|postFunctions>
--transitionIds=<value> Workflow's transition Id. You can provide multiple Ids by separeting them with comma to
filter the transitions.
Example usage: transitionIds=1,2,4
DESCRIPTION
Gets given workflow's transition rules
jira workflow search
Searches all workflows.
USAGE
$ jira workflow search [-n <value>] [--expand <value>] [--orderBy id|created|updated] [--orderDirection ASC|DSC]
[--query <value>] [--isActive] [--all | --startAt <value> | --maxResults <value>]
FLAGS
-n, --workflowName=<value>...
The name of a workflow to return. Multiple values can be provided by repeating this flag
Note: Providing multiple names feature is only available for cloud.
--all
Whether all responses are returned.
--expand=<value>
Use expand to include additional information in the response.
Options:
•`hasDraftWorkflow` For each workflow, returns information about whether the workflow has a draft version.
•`operations` For each workflow, returns information about the actions that can be undertaken on the workflow.
•`default` For each workflow, returns information about whether this is the default workflow.
--[no-]isActive
Filters active and inactive workflows.
--maxResults=<value>
[default: 20] The maximum number of items to return per page.
--orderBy=<option>
<options: id|created|updated>
--orderDirection=<option>
<options: ASC|DSC>
--query=<value>
Filter the results using a literal string. This only works for Jira Cloud.
--startAt=<value>
The index of the first item to return in a page of results (page offset).
DESCRIPTION
Searches all workflows.
jira worklog-property delete
Deletes a property for a worklog.
USAGE
$ jira worklog-property delete --issue <value> --worklogId <value> --key <value>
FLAGS
--issue=<value> (required) Issue ID or key.
--key=<value> (required) Property key.
--worklogId=<value> (required) Worklog ID.
DESCRIPTION
Deletes a property for a worklog.
jira worklog-property get
Gets the value of a property for a worklog.
USAGE
$ jira worklog-property get --issue <value> --worklogId <value> --key <value>
FLAGS
--issue=<value> (required) Issue ID or key.
--key=<value> (required) Property key.
--worklogId=<value> (required) Worklog ID.
DESCRIPTION
Gets the value of a property for a worklog.
jira worklog-property get-keys
Returns the keys of all the properties of a worklog.
USAGE
$ jira worklog-property get-keys --issue <value> --worklogId <value>
FLAGS
--issue=<value> (required) Issue ID or key.
--worklogId=<value> (required) Worklog ID.
DESCRIPTION
Returns the keys of all the properties of a worklog.
jira worklog-property set-property
Creates or updates the value of a property for a worklog.
USAGE
$ jira worklog-property set-property --issue <value> --worklogId <value> --key <value> --value <value>
FLAGS
--issue=<value> (required) Issue ID or key.
--key=<value> (required) Property key.
--value=<value> (required) Non-empty JSON blob. The maximum length is 32768 characters.
--worklogId=<value> (required) Worklog ID.
DESCRIPTION
Creates or updates the value of a property for a worklog.
jira worklog add
Adds a worklog to an issue.
USAGE
$ jira worklog add --issue <value> [--comment <value>] [--visibilityType role|group --visibilityValue <value>]
[--visibility <value> | ] [--started <value>] [--timeSpent <value> | --timeSpentSeconds <value>] [--property
<value>] [--newEstimate <value> --adjustEstimate new|leave|manual|auto] [--reduceBy <value> ] [--notifyUsers]
FLAGS
--adjustEstimate=<option> Defines how to update the issue's time estimate. Defaults to 'auto'.
<options: new|leave|manual|auto>
--comment=<value> A acomment about worklog. In ADF for Cloud and simple string for Server/DC.
--issue=<value> (required) Issue ID or key.
--newEstimate=<value> The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or
minutes (#m or #). For example, 2d. Required when adjustEstimate is new.
--notifyUsers notifyUsers Whether users watching the issue are notified by email. This parameter is only
for Jira Cloud.
--property=<value>... An entity property in the form of key/value. This parameter can be repeated.
--reduceBy=<value> The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or
minutes (#m). For example, 2d. Required when adjustEstimate is manual.
--started=<value> The datetime on which the worklog effort was started. Example:
2014-03-19T18:45:42.000+0200
--timeSpent=<value> The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Cannot
be provided if timeSpentSecond is provided.
--timeSpentSeconds=<value> The time in seconds spent working on the issue. Cannot be provided if timeSpent is
provided.
--visibility=<value> Visibility type and value in the form role/role_name or group/group_name.
--visibilityType=<option> Visibility of type of comment.
<options: role|group>
--visibilityValue=<value> Visibility type specific value. Role or group name.
DESCRIPTION
Adds a worklog to an issue.
jira worklog delete
Deletes a worklog.
USAGE
$ jira worklog delete --issue <value> --worklogId <value> [--adjustEstimate new|leave|manual|auto] [--newEstimate
<value>] [--increaseBy <value>] [--notifyUsers]
FLAGS
--adjustEstimate=<option> Defines how to update the issue's time estimate. Defaults to 'auto'.
<options: new|leave|manual|auto>
--increaseBy=<value> TThe amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or
minutes (#m or #). For example, 2d. Required when adjustEstimate is manual.
--issue=<value> (required) Issue ID or key.
--newEstimate=<value> The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or
minutes (#m or #). For example, 2d. Required when adjustEstimate is new.
--notifyUsers notifyUsers Whether users watching the issue are notified by email. This parameter is only
for Jira Cloud.
--worklogId=<value> (required) ID of Worklog
DESCRIPTION
Deletes a worklog.
jira worklog get
Returns a specific worklog.
USAGE
$ jira worklog get --issue <value> --worklogId <value>
FLAGS
--issue=<value> (required) Issue ID or key.
--worklogId=<value> (required) ID of Worklog
DESCRIPTION
Returns a specific worklog.
jira worklog get-deleted [SINCE]
Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
USAGE
$ jira worklog get-deleted [SINCE] [--since <value>]
ARGUMENTS
SINCE The date and time, as a UNIX timestamp in milliseconds or ISDO Date Time, after which deleted worklogs are
returned.
FLAGS
--since=<value> The date and time, as a UNIX timestamp in milliseconds or ISDO Date Time, after which deleted
worklogs are returned.
DESCRIPTION
Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
jira worklog get-for-issue
Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.
USAGE
$ jira worklog get-for-issue --issue <value> [--startAt <value>] [--maxResults <value>] [--startedAfter <value>]
FLAGS
--issue=<value> (required) Issue ID or key.
--maxResults=<value> [default: 20] The maximum number of items to return per page.
--startAt=<value> The index of the first item to return in a page of results (page offset).
--startedAfter=<value> The worklog start date and time. Can be an ISO Date Time or a UNIX timestamp in milliseconds,
after which worklogs are returned.
DESCRIPTION
Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and
time.
jira worklog get-updated [SINCE]
Returns a list of IDs and update timestamps for worklogs updated after a date and time.
USAGE
$ jira worklog get-updated [SINCE] [--since <value>]
ARGUMENTS
SINCE The date and time, as a UNIX timestamp in milliseconds or ISDO Date Time, after which deleted worklogs are
returned.
FLAGS
--since=<value> The date and time, as a UNIX timestamp in milliseconds or ISDO Date Time, after which deleted
worklogs are returned.
DESCRIPTION
Returns a list of IDs and update timestamps for worklogs updated after a date and time.
jira worklog get-with-ids [WORKLOGID]
Returns worklog details for a list of worklog IDs.
USAGE
$ jira worklog get-with-ids [WORKLOGID] [--worklogId <value>]
ARGUMENTS
WORKLOGID ID of Worklog
FLAGS
--worklogId=<value>... ID of Worklog
DESCRIPTION
Returns worklog details for a list of worklog IDs.
jira worklog update
Adds a worklog to an issue.
USAGE
$ jira worklog update --issue <value> --worklogId <value> [--comment <value>] [--visibilityType role|group
--visibilityValue <value>] [--visibility <value> | ] [--started <value>] [--timeSpent <value> | --timeSpentSeconds
<value>] [--property <value>] [--newEstimate <value> --adjustEstimate new|leave|auto] [--notifyUsers ]
FLAGS
--adjustEstimate=<option> Defines how to update the issue's time estimate. Defaults to 'auto'.
<options: new|leave|auto>
--comment=<value> A acomment about worklog. In ADF for Cloud and simple string for Server/DC.
--issue=<value> (required) Issue ID or key.
--newEstimate=<value> The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or
minutes (#m or #). For example, 2d. Required when adjustEstimate is new.
--notifyUsers notifyUsers Whether users watching the issue are notified by email. This parameter is only
for Jira Cloud.
--property=<value>... An entity property in the form of key/value. This parameter can be repeated.
--started=<value> The datetime on which the worklog effort was started. Example:
2014-03-19T18:45:42.000+0200
--timeSpent=<value> The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Cannot
be provided if timeSpentSecond is provided.
--timeSpentSeconds=<value> The time in seconds spent working on the issue. Cannot be provided if timeSpent is
provided.
--visibility=<value> Visibility type and value in the form role/role_name or group/group_name.
--visibilityType=<option> Visibility of type of comment.
<options: role|group>
--visibilityValue=<value> Visibility type specific value. Role or group name.
--worklogId=<value> (required) ID of Worklog
DESCRIPTION
Adds a worklog to an issue.