@thestarware/atlascli-jira v1.2.2
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 update
jira announcement-banner get
jira announcement-banner update
jira application-role update
jira application-role get
jira application-role get-all
jira application-role update
jira attachment add FILE
jira attachment delete ID
jira attachment get-content
jira attachment get-jira-settings
jira attachment get-metadata ID
jira attachment get-metadata-for-zip ID
jira attachment get-thumbnails
jira audit-record get-associated
jira audit-record get-changed
jira avatar delete-universal-avatar
jira avatar delete-user-avatar
jira avatar get-all-user-avatar
jira avatar get-image-by-id
jira avatar get-image-by-owner
jira avatar get-image-by-type
jira avatar get-system-avatars
jira avatar get-universal-avatars
jira avatar set-user-avatar
jira avatar upload-universal-avatar AVATARFILE
jira avatar upload-user-avatar AVATARFILE
jira comment-property delete-property
jira comment-property get-property
jira comment-property get-property-keys
jira comment-property set-property
jira comment add
jira comment delete
jira comment get
jira comment get-for-issue [ISSUE]
jira comment get-with-ids
jira comment update
jira config add
jira config delete [SITE]
jira config get-default
jira config list
jira config set-default [SITE]
jira dashboard-gadget add
jira dashboard-gadget get-availables
jira dashboard-gadget remove
jira dashboard-gadget search
jira dashboard-gadget update
jira dashboard-item-property delete
jira dashboard-item-property get
jira dashboard-item-property get-keys
jira dashboard-item-property set [JSONBODY]
jira dashboard add-edit-permission
jira dashboard add-share-permission
jira dashboard copy
jira dashboard create
jira dashboard delete
jira dashboard get [ID]
jira dashboard get-all
jira dashboard get-permissions
jira dashboard search
jira dashboard update
jira filter-sharing add-edit-permission
jira filter-sharing add-share-permission
jira filter-sharing delete-permission
jira filter-sharing get-default-scope
jira filter-sharing get-edit-permissions
jira filter-sharing get-permission
jira filter-sharing get-share-permissions
jira filter-sharing set-default-scope
jira filter add-favourite
jira filter change-owner
jira filter create
jira filter delete
jira filter get [ID]
jira filter get-columns
jira filter get-details
jira filter get-favourites
jira filter get-my
jira filter remove-favourite
jira filter reset-columns
jira filter search
jira filter set-columns
jira filter update
jira 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-groups
jira group get [GROUP]
jira group get-all
jira group get-users [GROUP]
jira group remove [GROUP]
jira group remove-user [USER] [GROUP]
jira help [COMMANDS]
jira issue-field-configuration assign-issue-type
jira issue-field-configuration assign-scheme-to-project
jira issue-field-configuration create
jira issue-field-configuration create-scheme
jira issue-field-configuration delete
jira issue-field-configuration delete-scheme
jira issue-field-configuration get-all
jira issue-field-configuration get-all-issue-type-items
jira issue-field-configuration get-all-schemes
jira issue-field-configuration get-items
jira issue-field-configuration get-project-schemes
jira issue-field-configuration remove-issue-types
jira issue-field-configuration update
jira issue-field-configuration update-items
jira issue-field-configuration update-scheme
jira issue-field-context add-issue-types
jira issue-field-context assign-to-projects
jira issue-field-context create
jira issue-field-context delete
jira issue-field-context get-all
jira issue-field-context get-contexts-for-projects-and-issue-types
jira issue-field-context get-default-values
jira issue-field-context get-issue-types
jira issue-field-context get-project-mappings
jira issue-field-context remove-from-projects
jira issue-field-context remove-issue-types
jira issue-field-context set-default-values
jira issue-field-context update
jira issue-field-option create-for-context
jira issue-field-option delete-for-context
jira issue-field-option get [OPTIONID]
jira issue-field-option get-for-context
jira issue-field-option reorder-for-context
jira issue-field-option update-for-context
jira issue-field create
jira issue-field delete
jira issue-field get-all
jira issue-field move-trash
jira issue-field restore-trash
jira issue-field search
jira issue-field search-trash
jira issue-field update
jira issue-link-type create
jira issue-link-type delete
jira issue-link-type get [ISSUELINKTYPEID]
jira issue-link-type get-all
jira issue-link-type update
jira issue-link create [ISSUELINKBODY]
jira issue-link delete [LINKID]
jira issue-link get [LINKID]
jira issue-navigator-setting get-columns
jira issue-navigator-setting set-columns
jira issue-priority create
jira issue-priority delete
jira issue-priority move
jira issue-priority search
jira issue-priority set-default
jira issue-priority update
jira issue-property delete
jira issue-property delete-bulk [JSONBODY]
jira issue-property get
jira issue-property get-keys
jira 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 delete
jira issue-remote-link delete-by-global-id
jira issue-remote-link get
jira issue-remote-link get-all
jira issue-remote-link update [ISSUEREMOTELINKBODY]
jira issue-resolution create
jira issue-resolution delete
jira issue-resolution get [ID]
jira issue-resolution get-all
jira issue-resolution move
jira issue-resolution search
jira issue-resolution set-default
jira issue-resolution update
jira issue-search get-picker-suggestions
jira issue-search search
jira issue-search test-jql
jira issue-security-level get [ISSUESECURITYLEVELID]
jira issue-security-level get-members
jira issue-security-scheme get [ISSUESECURITYSCHEMEID]
jira issue-security-scheme get-all
jira issue-security-scheme get-levels
jira issue-type-property delete
jira issue-type-property get
jira issue-type-property get-keys
jira issue-type-property set [JSONBODY]
jira issue-type-scheme add-issue-types
jira issue-type-scheme assign-to-project
jira issue-type-scheme create
jira issue-type-scheme delete
jira issue-type-scheme get-for-projects
jira issue-type-scheme get-issue-types
jira issue-type-scheme get-mappings
jira issue-type-scheme get-projects
jira issue-type-scheme move-issue-types
jira issue-type-scheme remove-all-projects
jira issue-type-scheme remove-issue-type
jira issue-type-scheme remove-project
jira issue-type-scheme search
jira issue-type-scheme set-projects
jira issue-type-scheme update
jira issue-type-screen-scheme add-mappings
jira issue-type-screen-scheme assign-to-project
jira issue-type-screen-scheme create
jira issue-type-screen-scheme delete
jira issue-type-screen-scheme get-for-projects
jira issue-type-screen-scheme get-items
jira issue-type-screen-scheme get-projects
jira issue-type-screen-scheme remove-mappings
jira issue-type-screen-scheme search
jira issue-type-screen-scheme set-default-screen
jira issue-type-screen-scheme update
jira issue-type create
jira issue-type delete
jira issue-type get [ID]
jira issue-type get-all
jira issue-type get-all-for-projects
jira issue-type get-alternatives
jira issue-type set-avatar
jira issue-type update
jira issue-type upload-avatar AVATARFILE
jira issue-vote add
jira issue-vote delete
jira issue-vote get-all
jira issue-watcher add
jira issue-watcher delete
jira issue-watcher get-all
jira issue-watcher get-bulk
jira issue archive [ISSUE]
jira issue assign
jira issue create [ISSUEBODY]
jira issue delete [ISSUE]
jira issue edit [ISSUEBODY]
jira issue get [ISSUE]
jira issue get-changelogs
jira issue get-create-metadata
jira issue get-edit-metadata [ISSUE]
jira issue get-events
jira issue get-transitions
jira issue restore [ISSUE]
jira issue send-notifications
jira issue transition [TRANSITIONBODY]
jira jira-expression analyse [JIRAEXPRESSIONBODY]
jira jira-expression evaluate [JIRAEXPRESSIONBODY]
jira jira-settings get-advanced
jira jira-settings get-globals
jira jira-settings get-properties
jira jira-settings set-property
jira jql convert-user-identifiers
jira jql get-auto-complete-suggestions
jira jql get-reference-data
jira jql parse
jira jql sanitize
jira label get-all
jira license get
jira myself change-password
jira myself delete-preference
jira myself get
jira myself get-locale
jira myself get-preference
jira myself set-preference [PREFERENCEBODY]
jira myself update-user
jira notification-scheme add [NOTIFICATIONBODY]
jira notification-scheme create [NOTIFICATIONBODY]
jira notification-scheme delete
jira notification-scheme delete-notification
jira notification-scheme get
jira notification-scheme get-all
jira notification-scheme get-projects
jira notification-scheme update
jira permission-scheme create-grant
jira permission-scheme create-scheme
jira permission-scheme delete-grant
jira permission-scheme delete-scheme
jira permission-scheme get
jira permission-scheme get-all
jira permission-scheme get-all-grants
jira permission-scheme get-grant
jira permission check-global-permission
jira permission check-issue-permission
jira permission check-project-permission
jira permission get-all
jira permission get-my
jira permission get-permitted [PERMISSION]
jira plugins
jira plugins:install PLUGIN...
jira plugins:inspect PLUGIN...
jira plugins:install PLUGIN...
jira plugins:link PLUGIN
jira plugins:uninstall PLUGIN...
jira plugins:uninstall PLUGIN...
jira plugins:uninstall PLUGIN...
jira plugins update
jira project-avatar delete
jira project-avatar get-all
jira project-avatar set
jira project-avatar upload AVATARFILE
jira project-category create
jira project-category delete
jira project-category get [ID]
jira project-category get-all
jira project-category update
jira project-component create
jira project-component delete
jira project-component get [ID]
jira project-component get-all
jira project-component get-issues-count
jira project-component search
jira project-component update
jira project-email get-sender
jira project-email set-sender
jira project-feature get [PROJECT]
jira project-feature set
jira project-key-and-name-validation get-valid-key
jira project-key-and-name-validation get-valid-name
jira project-key-and-name-validation validate-key
jira project-permission-scheme get
jira project-permission-scheme get-issue-security-levels
jira project-permission-scheme get-issue-security-scheme
jira project-permission-scheme get-issue-security-scheme-levels
jira project-permission-scheme get-permissions
jira project-permission-scheme set
jira project-property delete
jira project-property get
jira project-property get-keys
jira project-property set
jira project-role-actor add-actors
jira project-role-actor add-default-actors
jira project-role-actor delete-actors
jira project-role-actor delete-default-actors
jira project-role-actor get
jira project-role-actor set-actors
jira project-role create
jira project-role delete
jira project-role get [ID]
jira project-role get-all
jira project-role get-role
jira project-role get-roles
jira project-role get-roles-and-details
jira project-role project-role
jira project-role update
jira project-role update-partial
jira project-type check-accessible
jira project-type get [KEY]
jira project-type get-all
jira project-type get-licensed
jira project-type update
jira project-version create
jira project-version delete-and-replace
jira project-version get [ID]
jira project-version get-all
jira project-version get-related-issue-count
jira project-version get-unresolved-issue-count
jira project-version merge
jira project-version move
jira project-version search
jira project-version update
jira project archive
jira project create
jira project delete
jira project get [PROJECT]
jira project get-all
jira project get-all-issue-types
jira project get-issue-type-hierarchy
jira project get-notification-schema
jira project project
jira project restore
jira project search
jira project unarchive
jira project update
jira screen-scheme create
jira screen-scheme delete
jira screen-scheme get-all
jira screen-scheme update
jira screen-tab-field add
jira screen-tab-field get-all
jira screen-tab-field move
jira screen-tab-field remove
jira screen-tab create
jira screen-tab delete
jira screen-tab get-all
jira screen-tab move
jira screen-tab update
jira screen add-field-to-default-screen
jira screen create
jira screen delete
jira screen get-all
jira screen get-available-fields
jira screen get-field-screens
jira screen get-workflows
jira screen update
jira server-info get
jira server-info jmx
jira status create
jira status delete [STATUSID]
jira status get [STATUSID]
jira status get-usages
jira status search
jira status status-command
jira status update
jira task cancel
jira task get [TASKID]
jira time-tracking get
jira time-tracking get-all
jira time-tracking get-setting
jira time-tracking select
jira time-tracking set
jira update [CHANNEL]
jira user-property delete
jira user-property get-all-keys
jira user-property get-user-property
jira user-property set [VALUE]
jira user-search accounts-with-query
jira user-search assignable-users
jira user-search assignable-users-bulk
jira user-search find
jira user-search with-permission
jira user-search with-query
jira user add-user-to-application
jira user change-password
jira user create
jira user delete
jira user get [USER]
jira user get-all
jira user get-default-columns [USER]
jira user get-email [USER]
jira user get-user-groups [USER]
jira user remove-user-from-application
jira user reset-default-columns [USER]
jira user set-default-columns
jira user update
jira user user-command
jira workflow-scheme-draft create
jira workflow-scheme-draft delete
jira workflow-scheme-draft delete-default-workflow
jira workflow-scheme-draft delete-issue-types-for-workflow
jira workflow-scheme-draft delete-workflow-for-issue-type
jira workflow-scheme-draft get [WORKFLOWSCHEMEID]
jira workflow-scheme-draft get-default-workflow
jira workflow-scheme-draft get-issue-types-for-workflows
jira workflow-scheme-draft get-workflow-for-issue-type
jira workflow-scheme-draft publish
jira workflow-scheme-draft set-issue-types-for-workflow
jira workflow-scheme-draft set-workflow-for-issue-type
jira workflow-scheme-draft update [WORKFLOWSCHEMEBODY]
jira workflow-scheme-draft update-default-workflow
jira workflow-scheme-project-association assign
jira workflow-scheme-project-association get-all
jira workflow-scheme create [WORKFLOWSCHEMEBODY]
jira workflow-scheme delete
jira workflow-scheme delete-default-workflow
jira workflow-scheme delete-issue-types-for-workflow
jira workflow-scheme delete-workflow-for-issue-type
jira workflow-scheme get [WORKFLOWSCHEMEID]
jira workflow-scheme get-all
jira workflow-scheme get-default-workflow
jira workflow-scheme get-issue-types-for-workflows
jira workflow-scheme get-workflow-for-issue-type
jira workflow-scheme set-issue-types-for-workflow
jira workflow-scheme set-workflow-for-issue-type
jira workflow-scheme update [WORKFLOWSCHEMEBODY]
jira workflow-scheme update-default-workflow
jira workflow-status-category get
jira workflow-status-category get-all
jira workflow-status get [IDORNAME]
jira workflow-status get-all
jira workflow-transition-property create
jira workflow-transition-property delete
jira workflow-transition-property get
jira workflow-transition-property update
jira workflow create [WORKFLOWBODY]
jira workflow delete
jira workflow get-projects
jira workflow get-schemes
jira workflow get-statuses
jira workflow get-statuses-properties
jira workflow get-transitions
jira workflow get-transitions-rules
jira workflow search
jira worklog-property delete
jira worklog-property get
jira worklog-property get-keys
jira worklog-property set-property
jira worklog add
jira worklog delete
jira worklog get
jira worklog get-deleted [SINCE]
jira worklog get-for-issue
jira 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 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 327