@thestarware/atlascli-jira
v1.2.8
Published
ATLAS CLI for Jira: Command Line Tool
Maintainers
Readme
Usage
"ATLAS CLI for Jira" is a command line tool for Jira. It will not work unless the corresponding paid add-on is installed to Jira.
$ npm install -g @thestarware/atlascli-jira
$ jira COMMAND
running command...
$ jira (--version)
@thestarware/atlascli-jira/1.1.0 darwin-arm64 node-v16.13.1
$ jira --help [COMMAND]
USAGE
$ jira COMMAND
...Commands
jira announcement-banner updatejira announcement-banner getjira announcement-banner updatejira application-role updatejira application-role getjira application-role get-alljira application-role updatejira attachment add FILEjira attachment delete IDjira attachment get-contentjira attachment get-jira-settingsjira attachment get-metadata IDjira attachment get-metadata-for-zip IDjira attachment get-thumbnailsjira audit-record get-associatedjira audit-record get-changedjira avatar delete-universal-avatarjira avatar delete-user-avatarjira avatar get-all-user-avatarjira avatar get-image-by-idjira avatar get-image-by-ownerjira avatar get-image-by-typejira avatar get-system-avatarsjira avatar get-universal-avatarsjira avatar set-user-avatarjira avatar upload-universal-avatar AVATARFILEjira avatar upload-user-avatar AVATARFILEjira comment-property delete-propertyjira comment-property get-propertyjira comment-property get-property-keysjira comment-property set-propertyjira comment addjira comment deletejira comment getjira comment get-for-issue [ISSUE]jira comment get-with-idsjira comment updatejira config addjira config delete [SITE]jira config get-defaultjira config listjira config set-default [SITE]jira dashboard-gadget addjira dashboard-gadget get-availablesjira dashboard-gadget removejira dashboard-gadget searchjira dashboard-gadget updatejira dashboard-item-property deletejira dashboard-item-property getjira dashboard-item-property get-keysjira dashboard-item-property set [JSONBODY]jira dashboard add-edit-permissionjira dashboard add-share-permissionjira dashboard copyjira dashboard createjira dashboard deletejira dashboard get [ID]jira dashboard get-alljira dashboard get-permissionsjira dashboard searchjira dashboard updatejira filter-sharing add-edit-permissionjira filter-sharing add-share-permissionjira filter-sharing delete-permissionjira filter-sharing get-default-scopejira filter-sharing get-edit-permissionsjira filter-sharing get-permissionjira filter-sharing get-share-permissionsjira filter-sharing set-default-scopejira filter add-favouritejira filter change-ownerjira filter createjira filter deletejira filter get [ID]jira filter get-columnsjira filter get-detailsjira filter get-favouritesjira filter get-myjira filter remove-favouritejira filter reset-columnsjira filter searchjira filter set-columnsjira filter updatejira group-and-user-picker find-groups [QUERY]jira group-and-user-picker find-users [QUERY]jira group add-user [USER] [GROUP]jira group create [NAME]jira group find-groupsjira group get [GROUP]jira group get-alljira group get-users [GROUP]jira group remove [GROUP]jira group remove-user [USER] [GROUP]jira help [COMMANDS]jira issue-field-configuration assign-issue-typejira issue-field-configuration assign-scheme-to-projectjira issue-field-configuration createjira issue-field-configuration create-schemejira issue-field-configuration deletejira issue-field-configuration delete-schemejira issue-field-configuration get-alljira issue-field-configuration get-all-issue-type-itemsjira issue-field-configuration get-all-schemesjira issue-field-configuration get-itemsjira issue-field-configuration get-project-schemesjira issue-field-configuration remove-issue-typesjira issue-field-configuration updatejira issue-field-configuration update-itemsjira issue-field-configuration update-schemejira issue-field-context add-issue-typesjira issue-field-context assign-to-projectsjira issue-field-context createjira issue-field-context deletejira issue-field-context get-alljira issue-field-context get-contexts-for-projects-and-issue-typesjira issue-field-context get-default-valuesjira issue-field-context get-issue-typesjira issue-field-context get-project-mappingsjira issue-field-context remove-from-projectsjira issue-field-context remove-issue-typesjira issue-field-context set-default-valuesjira issue-field-context updatejira issue-field-option create-for-contextjira issue-field-option delete-for-contextjira issue-field-option get [OPTIONID]jira issue-field-option get-for-contextjira issue-field-option reorder-for-contextjira issue-field-option update-for-contextjira issue-field createjira issue-field deletejira issue-field get-alljira issue-field move-trashjira issue-field restore-trashjira issue-field searchjira issue-field search-trashjira issue-field updatejira issue-link-type createjira issue-link-type deletejira issue-link-type get [ISSUELINKTYPEID]jira issue-link-type get-alljira issue-link-type updatejira issue-link create [ISSUELINKBODY]jira issue-link delete [LINKID]jira issue-link get [LINKID]jira issue-navigator-setting get-columnsjira issue-navigator-setting set-columnsjira issue-priority createjira issue-priority deletejira issue-priority movejira issue-priority searchjira issue-priority set-defaultjira issue-priority updatejira issue-property deletejira issue-property delete-bulk [JSONBODY]jira issue-property getjira issue-property get-keysjira issue-property set [JSONBODY]jira issue-property set-bulk [JSONBODY]jira issue-property set-by-issue-bulk [JSONBODY]jira issue-property set-by-list-bulk [JSONBODY]jira issue-remote-link create [ISSUEREMOTELINKBODY]jira issue-remote-link deletejira issue-remote-link delete-by-global-idjira issue-remote-link getjira issue-remote-link get-alljira issue-remote-link update [ISSUEREMOTELINKBODY]jira issue-resolution createjira issue-resolution deletejira issue-resolution get [ID]jira issue-resolution get-alljira issue-resolution movejira issue-resolution searchjira issue-resolution set-defaultjira issue-resolution updatejira issue-search get-picker-suggestionsjira issue-search searchjira issue-search test-jqljira issue-security-level get [ISSUESECURITYLEVELID]jira issue-security-level get-membersjira issue-security-scheme get [ISSUESECURITYSCHEMEID]jira issue-security-scheme get-alljira issue-security-scheme get-levelsjira issue-type-property deletejira issue-type-property getjira issue-type-property get-keysjira issue-type-property set [JSONBODY]jira issue-type-scheme add-issue-typesjira issue-type-scheme assign-to-projectjira issue-type-scheme createjira issue-type-scheme deletejira issue-type-scheme get-for-projectsjira issue-type-scheme get-issue-typesjira issue-type-scheme get-mappingsjira issue-type-scheme get-projectsjira issue-type-scheme move-issue-typesjira issue-type-scheme remove-all-projectsjira issue-type-scheme remove-issue-typejira issue-type-scheme remove-projectjira issue-type-scheme searchjira issue-type-scheme set-projectsjira issue-type-scheme updatejira issue-type-screen-scheme add-mappingsjira issue-type-screen-scheme assign-to-projectjira issue-type-screen-scheme createjira issue-type-screen-scheme deletejira issue-type-screen-scheme get-for-projectsjira issue-type-screen-scheme get-itemsjira issue-type-screen-scheme get-projectsjira issue-type-screen-scheme remove-mappingsjira issue-type-screen-scheme searchjira issue-type-screen-scheme set-default-screenjira issue-type-screen-scheme updatejira issue-type createjira issue-type deletejira issue-type get [ID]jira issue-type get-alljira issue-type get-all-for-projectsjira issue-type get-alternativesjira issue-type set-avatarjira issue-type updatejira issue-type upload-avatar AVATARFILEjira issue-vote addjira issue-vote deletejira issue-vote get-alljira issue-watcher addjira issue-watcher deletejira issue-watcher get-alljira issue-watcher get-bulkjira issue archive [ISSUE]jira issue assignjira issue create [ISSUEBODY]jira issue delete [ISSUE]jira issue edit [ISSUEBODY]jira issue get [ISSUE]jira issue get-changelogsjira issue get-create-metadatajira issue get-edit-metadata [ISSUE]jira issue get-eventsjira issue get-transitionsjira issue restore [ISSUE]jira issue send-notificationsjira issue transition [TRANSITIONBODY]jira jira-expression analyse [JIRAEXPRESSIONBODY]jira jira-expression evaluate [JIRAEXPRESSIONBODY]jira jira-settings get-advancedjira jira-settings get-globalsjira jira-settings get-propertiesjira jira-settings set-propertyjira jql convert-user-identifiersjira jql get-auto-complete-suggestionsjira jql get-reference-datajira jql parsejira jql sanitizejira label get-alljira license getjira myself change-passwordjira myself delete-preferencejira myself getjira myself get-localejira myself get-preferencejira myself set-preference [PREFERENCEBODY]jira myself update-userjira notification-scheme add [NOTIFICATIONBODY]jira notification-scheme create [NOTIFICATIONBODY]jira notification-scheme deletejira notification-scheme delete-notificationjira notification-scheme getjira notification-scheme get-alljira notification-scheme get-projectsjira notification-scheme updatejira permission-scheme create-grantjira permission-scheme create-schemejira permission-scheme delete-grantjira permission-scheme delete-schemejira permission-scheme getjira permission-scheme get-alljira permission-scheme get-all-grantsjira permission-scheme get-grantjira permission check-global-permissionjira permission check-issue-permissionjira permission check-project-permissionjira permission get-alljira permission get-myjira permission get-permitted [PERMISSION]jira pluginsjira plugins:install PLUGIN...jira plugins:inspect PLUGIN...jira plugins:install PLUGIN...jira plugins:link PLUGINjira plugins:uninstall PLUGIN...jira plugins:uninstall PLUGIN...jira plugins:uninstall PLUGIN...jira plugins updatejira project-avatar deletejira project-avatar get-alljira project-avatar setjira project-avatar upload AVATARFILEjira project-category createjira project-category deletejira project-category get [ID]jira project-category get-alljira project-category updatejira project-component createjira project-component deletejira project-component get [ID]jira project-component get-alljira project-component get-issues-countjira project-component searchjira project-component updatejira project-email get-senderjira project-email set-senderjira project-feature get [PROJECT]jira project-feature setjira project-key-and-name-validation get-valid-keyjira project-key-and-name-validation get-valid-namejira project-key-and-name-validation validate-keyjira project-permission-scheme getjira project-permission-scheme get-issue-security-levelsjira project-permission-scheme get-issue-security-schemejira project-permission-scheme get-issue-security-scheme-levelsjira project-permission-scheme get-permissionsjira project-permission-scheme setjira project-property deletejira project-property getjira project-property get-keysjira project-property setjira project-role-actor add-actorsjira project-role-actor add-default-actorsjira project-role-actor delete-actorsjira project-role-actor delete-default-actorsjira project-role-actor getjira project-role-actor set-actorsjira project-role createjira project-role deletejira project-role get [ID]jira project-role get-alljira project-role get-rolejira project-role get-rolesjira project-role get-roles-and-detailsjira project-role project-rolejira project-role updatejira project-role update-partialjira project-type check-accessiblejira project-type get [KEY]jira project-type get-alljira project-type get-licensedjira project-type updatejira project-version createjira project-version delete-and-replacejira project-version get [ID]jira project-version get-alljira project-version get-related-issue-countjira project-version get-unresolved-issue-countjira project-version mergejira project-version movejira project-version searchjira project-version updatejira project archivejira project createjira project deletejira project get [PROJECT]jira project get-alljira project get-all-issue-typesjira project get-issue-type-hierarchyjira project get-notification-schemajira project projectjira project restorejira project searchjira project unarchivejira project updatejira screen-scheme createjira screen-scheme deletejira screen-scheme get-alljira screen-scheme updatejira screen-tab-field addjira screen-tab-field get-alljira screen-tab-field movejira screen-tab-field removejira screen-tab createjira screen-tab deletejira screen-tab get-alljira screen-tab movejira screen-tab updatejira screen add-field-to-default-screenjira screen createjira screen deletejira screen get-alljira screen get-available-fieldsjira screen get-field-screensjira screen get-workflowsjira screen updatejira server-info getjira server-info jmxjira status createjira status delete [STATUSID]jira status get [STATUSID]jira status get-usagesjira status searchjira status status-commandjira status updatejira task canceljira task get [TASKID]jira time-tracking getjira time-tracking get-alljira time-tracking get-settingjira time-tracking selectjira time-tracking setjira update [CHANNEL]jira user-property deletejira user-property get-all-keysjira user-property get-user-propertyjira user-property set [VALUE]jira user-search accounts-with-queryjira user-search assignable-usersjira user-search assignable-users-bulkjira user-search findjira user-search with-permissionjira user-search with-queryjira user add-user-to-applicationjira user change-passwordjira user createjira user deletejira user get [USER]jira user get-alljira user get-default-columns [USER]jira user get-email [USER]jira user get-user-groups [USER]jira user remove-user-from-applicationjira user reset-default-columns [USER]jira user set-default-columnsjira user updatejira user user-commandjira workflow-scheme-draft createjira workflow-scheme-draft deletejira workflow-scheme-draft delete-default-workflowjira workflow-scheme-draft delete-issue-types-for-workflowjira workflow-scheme-draft delete-workflow-for-issue-typejira workflow-scheme-draft get [WORKFLOWSCHEMEID]jira workflow-scheme-draft get-default-workflowjira workflow-scheme-draft get-issue-types-for-workflowsjira workflow-scheme-draft get-workflow-for-issue-typejira workflow-scheme-draft publishjira workflow-scheme-draft set-issue-types-for-workflowjira workflow-scheme-draft set-workflow-for-issue-typejira workflow-scheme-draft update [WORKFLOWSCHEMEBODY]jira workflow-scheme-draft update-default-workflowjira workflow-scheme-project-association assignjira workflow-scheme-project-association get-alljira workflow-scheme create [WORKFLOWSCHEMEBODY]jira workflow-scheme deletejira workflow-scheme delete-default-workflowjira workflow-scheme delete-issue-types-for-workflowjira workflow-scheme delete-workflow-for-issue-typejira workflow-scheme get [WORKFLOWSCHEMEID]jira workflow-scheme get-alljira workflow-scheme get-default-workflowjira workflow-scheme get-issue-types-for-workflowsjira workflow-scheme get-workflow-for-issue-typejira workflow-scheme set-issue-types-for-workflowjira workflow-scheme set-workflow-for-issue-typejira workflow-scheme update [WORKFLOWSCHEMEBODY]jira workflow-scheme update-default-workflowjira workflow-status-category getjira workflow-status-category get-alljira workflow-status get [IDORNAME]jira workflow-status get-alljira workflow-transition-property createjira workflow-transition-property deletejira workflow-transition-property getjira workflow-transition-property updatejira workflow create [WORKFLOWBODY]jira workflow deletejira workflow get-projectsjira workflow get-schemesjira workflow get-statusesjira workflow get-statuses-propertiesjira workflow get-transitionsjira workflow get-transitions-rulesjira workflow searchjira worklog-property deletejira worklog-property getjira worklog-property get-keysjira worklog-property set-propertyjira worklog addjira worklog deletejira worklog getjira worklog get-deleted [SINCE]jira worklog get-for-issuejira worklog get-updated [SINCE]jira worklog get-with-ids [WORKLOGID]jira worklog update
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 updatejira 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 updatejira 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 updatejira 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 updatejira 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 descriptionjira 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 propertyjira 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 327