Jira Cloud Platform — Printing Press CLI
Prerequisites: Install the CLI
This skill drives the jira-pp-cli binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
- Install via the Printing Press installer. It defaults binaries to
$HOME/.local/bin on macOS/Linux and %LOCALAPPDATA%\Programs\PrintingPress\bin on Windows:npx -y @mvanhorn/printing-press-library install jira --cli-only
- Verify:
jira-pp-cli --version
- Ensure the reported install directory is on
$PATH for the agent/runtime that will invoke this skill.
If the npx install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer):
go install github.com/mvanhorn/printing-press-library/library/project-management/jira/cmd/jira-pp-cli@latest
If --version reports "command not found" after install, the runtime cannot see the binary directory on $PATH. Do not proceed with skill commands until verification succeeds.
Command Reference
announcement-banner — This resource represents an announcement banner. Use it to retrieve and update banner configuration.
jira-pp-cli announcement-banner get-banner — Returns the current announcement banner configuration. Permissions required: Administer Jira...
jira-pp-cli announcement-banner set-banner — Updates the announcement banner configuration. Permissions required: Administer Jira [global...
app — Manage app
jira-pp-cli app get-custom-field-configuration — Returns a paginated list of configurations for a custom field of a...
jira-pp-cli app get-custom-fields-configurations — Returns a paginated list of configurations for list of custom fields of a...
jira-pp-cli app update-custom-field-configuration — Update the configuration for contexts of a custom field of a [type](https://developer.atlassian.com/platform/forge/ma...
jira-pp-cli app update-custom-field-value — Updates the value of a custom field on one or more issues. Apps can only perform this operation on [custom...
jira-pp-cli app update-multiple-custom-field-values — Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should...
application-properties — Manage application properties
jira-pp-cli application-properties get-advanced-settings — Returns the application properties that are accessible on the Advanced Settings page. To navigate to the *Advanced...
jira-pp-cli application-properties get-application-property — Returns all application properties or an application property. If you specify a value for the key parameter, then...
jira-pp-cli application-properties set-application-property — Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from...
applicationrole — Manage applicationrole
jira-pp-cli applicationrole get-all-application-roles — Returns all application roles. In Jira, application roles are managed using the [Application access...
jira-pp-cli applicationrole get-application-role — Returns an application role. Permissions required: Administer Jira [global...
atlassian-connect — Manage atlassian connect
jira-pp-cli atlassian-connect addon-properties-resource-delete-addon-property-delete — Deletes an app's property. Permissions required: Only a Connect app whose key matches addonKey...
jira-pp-cli atlassian-connect addon-properties-resource-get-addon-properties-get — Gets all the properties of an app. The reserved key connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8 is not...
jira-pp-cli atlassian-connect addon-properties-resource-get-addon-property-get — Returns the key and value of an app's property. The property key...
jira-pp-cli atlassian-connect addon-properties-resource-put-addon-property-put — Sets the value of an app's property. Use this resource to store custom data for your app. The value of the request...
jira-pp-cli atlassian-connect app-issue-field-value-update-resource-update-issue-fields-put — Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom...
jira-pp-cli atlassian-connect connect-to-forge-migration-fetch-task-resource-fetch-migration-task-get — Returns the details of a Connect issue field's migration to Forge. When migrating a Connect app to Forge, [Issue...
jira-pp-cli atlassian-connect connect-to-forge-migration-task-submission-resource-submit-task-post — Submits a request to trigger migration of connect issue field to its Forge custom field counterpart. When migrating...
jira-pp-cli atlassian-connect dynamic-modules-resource-get-modules-get — Returns all modules registered dynamically by the calling app. Permissions required: Only...
jira-pp-cli atlassian-connect dynamic-modules-resource-register-modules-post — Registers a list of modules. Permissions required: Only Connect apps can make this request.
jira-pp-cli atlassian-connect dynamic-modules-resource-remove-modules-delete — Remove all or a list of modules registered by the calling app. Permissions required: Only...
jira-pp-cli atlassian-connect migration-resource-update-entity-properties-value-put — Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for...
jira-pp-cli atlassian-connect migration-resource-workflow-rule-search-post — Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.
jira-pp-cli atlassian-connect service-registry-resource-services-get — Retrieve the attributes of given service registries. Permissions required: Only Connect apps can...
attachment — Manage attachment
jira-pp-cli attachment get — Returns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be...
jira-pp-cli attachment get-content — Returns the contents of an attachment. A Range header can be set to define a range of bytes within the attachment...
jira-pp-cli attachment get-meta — Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed....
jira-pp-cli attachment get-thumbnail — Returns the thumbnail of an attachment. To return the attachment contents, use [Get attachment...
jira-pp-cli attachment remove — Deletes an attachment from an issue. This operation can be accessed anonymously. **Permissions...
auditing — Manage auditing
jira-pp-cli auditing — Returns a list of audit records. The list can be filtered to include items: * where each item in filter has at...
avatar — This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project, issue type or priority and obtain avatar images.
bulk — Manage bulk
jira-pp-cli bulk get-available-transitions — Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk...
jira-pp-cli bulk get-editable-fields — Use this API to get a list of fields visible to the user to perform bulk edit operations. You can pass single or...
jira-pp-cli bulk get-operation-progress — Use this to get the progress state for the specified bulk operation taskId. **Permissions...
jira-pp-cli bulk submit-delete — Use this API to submit a bulk delete request. You can delete up to 1,000 issues in a single operation....
jira-pp-cli bulk submit-edit — Use this API to submit a bulk edit request and simultaneously edit multiple issues. There are limits applied to the...
jira-pp-cli bulk submit-move — Use this API to submit a bulk issue move request. You can move multiple issues from multiple projects in a single...
jira-pp-cli bulk submit-transition — Use this API to submit a bulk issue status transition request. You can transition multiple issues, alongside with...
jira-pp-cli bulk submit-unwatch — Use this API to submit a bulk unwatch request. You can unwatch up to 1,000 issues in a single operation....
jira-pp-cli bulk submit-watch — Use this API to submit a bulk watch request. You can watch up to 1,000 issues in a single operation....
changelog — Manage changelog
jira-pp-cli changelog — Bulk fetch changelogs for multiple issues and filter by fields Returns a paginated list of all changelogs for given...
classification-levels — This resource represents classification levels.
jira-pp-cli classification-levels — Returns all classification levels. Permissions required: None.
comment — Manage comment
jira-pp-cli comment — Returns a paginated list of comments specified by a list of comment IDs. This operation can be...
component — Manage component
jira-pp-cli component create — Creates a component. Use components to provide containers for issues within a project. Use components to provide...
jira-pp-cli component delete — Deletes a component. This operation can be accessed anonymously. Permissions required:...
jira-pp-cli component find-for-projects — Returns a paginated list of all components in a project, including global (Compass) components when...
jira-pp-cli component get — Returns a component. This operation can be accessed anonymously. Permissions required: *Browse...
jira-pp-cli component update — Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ('')...
config — Manage config
jira-pp-cli config associate-projects-to-field-association-schemes — Associate projects to field association schemes. Permissions required: Administer Jira [global...
jira-pp-cli config clone-field-association-scheme — Endpoint for cloning an existing field association scheme into a new one. Permissions required:...
jira-pp-cli config create-field-association-scheme — Endpoint for creating a new field association scheme. Permissions required: Administer Jira...
jira-pp-cli config delete-field-association-scheme — Delete a specified field association scheme Permissions required: Administer Jira [global...
jira-pp-cli config get-field-association-scheme-by-id — Endpoint for fetching a field association scheme by its ID Permissions required: *Administer...
jira-pp-cli config get-field-association-scheme-item-parameters — Retrieve field association parameters on a field association scheme Permissions required:...
jira-pp-cli config get-field-association-schemes — REST endpoint for retrieving a paginated list of field association schemes with optional filtering. This endpoint...
jira-pp-cli config get-projects-with-field-schemes — Get projects with field association schemes. This will be a temporary API but useful when transitioning from the...
jira-pp-cli config remove-field-association-scheme-item-parameters — Remove field association parameters overrides for work types. Permissions required: *Administer...
jira-pp-cli config remove-fields-associated-with-schemes — Remove fields associated with field association schemes. Permissions required: Administer Jira...
jira-pp-cli config search-field-association-scheme-fields — Search for fields belonging to a given field association scheme. Permissions required:...
jira-pp-cli config search-field-association-scheme-projects — REST Endpoint for searching for projects belonging to a given field association scheme **Permissions...
jira-pp-cli config update-field-association-scheme — Endpoint for updating an existing field association scheme. Permissions required: *Administer...
jira-pp-cli config update-field-association-scheme-item-parameters — Update field association item parameters in field association schemes. Permissions required:...
jira-pp-cli config update-fields-associated-with-schemes — Update fields associated with field association schemes. Permissions required: Administer Jira...
configuration — Manage configuration
jira-pp-cli configuration get — Returns the global settings in Jira. These settings determine whether...
jira-pp-cli configuration get-available-time-tracking-implementations — Returns all time tracking providers. By default, Jira only has one time tracking provider: *JIRA provided time...
jira-pp-cli configuration get-selected-time-tracking-implementation — Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a...
jira-pp-cli configuration get-shared-time-tracking — Returns the time tracking settings. This includes settings such as the time format, default time unit, and others....
jira-pp-cli configuration select-time-tracking-implementation — Selects a time tracking provider. Permissions required: Administer Jira [global...
jira-pp-cli configuration set-shared-time-tracking — Sets the time tracking settings. Permissions required: Administer Jira [global...
custom-field-option — Manage custom field option
jira-pp-cli custom-field-option <id> — Returns a custom field option. For example, an option in a select list. Note that this operation **only works for...
dashboard — This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards.
jira-pp-cli dashboard bulk-edit — Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100....
jira-pp-cli dashboard create — Creates a dashboard. Permissions required: None.
jira-pp-cli dashboard delete — Deletes a dashboard. Permissions required: None The dashboard to be deleted must be owned by the...
jira-pp-cli dashboard get — Returns a dashboard. This operation can be accessed anonymously. Permissions required: None....
jira-pp-cli dashboard get-all — Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or...
jira-pp-cli dashboard get-all-available-gadgets — Gets a list of all available gadgets that can be added to all dashboards. Permissions required:...
jira-pp-cli dashboard get-paginated — Returns a paginated list of dashboards. This operation is similar to [Get...
jira-pp-cli dashboard update — Updates a dashboard, replacing all the dashboard details with those provided. **Permissions...
data-policy — Manage data policy
jira-pp-cli data-policy get-policies — Returns data policies for the projects specified in the request.
jira-pp-cli data-policy get-policy — Returns data policy for the workspace.
events — Manage events
jira-pp-cli events — Returns all issue events. Permissions required: Administer Jira [global...
expression — Manage expression
jira-pp-cli expression analyse — Analyses and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check...
jira-pp-cli expression evaluate-jira — Endpoint is currently being removed. More details...
jira-pp-cli expression evaluate-jsisjira — Evaluates a Jira expression and returns its value. The difference between this and eval is that this endpoint uses...
field — Manage field
jira-pp-cli field create-associations — Associates fields with projects. Fields will be associated with each issue type on the requested projects. Fields...
jira-pp-cli field create-custom — Creates a custom field. Permissions required: Administer Jira [global...
jira-pp-cli field delete-custom — Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom...
jira-pp-cli field get — Returns system and custom issue fields according to the following rules: * Fields that cannot be added to the issue...
jira-pp-cli field get-paginated — Returns a paginated list of fields for Classic Jira projects. The list can include: * all fields *...
jira-pp-cli field get-trashed-paginated — Returns a paginated list of fields in the trash. The list may be restricted to fields whose field...
jira-pp-cli field remove-associations — Unassociates a set of fields with a project and issue type context. Fields will be unassociated with all...
jira-pp-cli field update-custom — Updates a custom field. Permissions required: Administer Jira [global...
fieldconfiguration — Manage fieldconfiguration
fieldconfigurationscheme — Manage fieldconfigurationscheme
filter — This resource represents filters. Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.
jira-pp-cli filter create — Creates a filter. The filter is shared according to the default share scope. The...
jira-pp-cli filter delete — Delete a filter. Permissions required: Permission to access Jira, however filters can only be...
jira-pp-cli filter get — Returns a filter. This operation can be accessed anonymously. Permissions required: None,...
jira-pp-cli filter get-default-share-scope — Returns the default sharing settings for new filters and dashboards for a user. **Permissions...
jira-pp-cli filter get-favourite — Returns the visible favorite filters of the user. This operation can be accessed anonymously....
jira-pp-cli filter get-my — Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are...
jira-pp-cli filter get-paginated — Returns a paginated list of filters. Use this operation to get: * specific filters, by defining id...
jira-pp-cli filter set-default-share-scope — Sets the default sharing for new filters and dashboards for a user. Permissions required:...
jira-pp-cli filter update — Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing....
forge — Manage forge
jira-pp-cli forge bulk-pin-unpin-projects-async — Bulk pin or unpin an issue panel (added by a Forge app) to or from multiple projects. The operation runs...
jira-pp-cli forge delete-app-property — Deletes a Forge app's property. Permissions required: Only Forge apps can make this request....
jira-pp-cli forge get-app-property — Returns the value of a Forge app's property. Permissions required: Only Forge apps can make this...
jira-pp-cli forge get-app-property-keys — Returns all property keys for the Forge app. Permissions required: Only Forge apps can make this...
jira-pp-cli forge put-app-property — Sets the value of a Forge app's property. These values can be retrieved in [Jira...
group — This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. ([WARNING] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)
jira-pp-cli group add-user-to — Adds a user to a group. Permissions required: Site administration (that is, member of the...
jira-pp-cli group bulk-get — Returns a paginated list of groups. Permissions required: *Browse users and...
jira-pp-cli group create — Creates a group. Permissions required: Site administration (that is, member of the site-admin...
jira-pp-cli group get — This operation is deprecated, use group/member. Returns all users in a group....
jira-pp-cli group get-users-from — Returns a paginated list of all users in a group. Note that users are ordered by username, however...
jira-pp-cli group remove — Deletes a group. Permissions required: Site administration (that is, member of the site-admin...
jira-pp-cli group remove-user-from — Removes a user from a group. Permissions required: Site administration (that is, member of the...
groups — This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. ([WARNING] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)
jira-pp-cli groups — Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups...
groupuserpicker — Manage groupuserpicker
jira-pp-cli groupuserpicker — Returns a list of users and groups matching a string. The string is used: * for users, to find a case-insensitive...
instance — Manage instance
jira-pp-cli instance — Returns licensing information about the Jira instance. Permissions required: None.
internal — Manage internal
jira-pp-cli internal — Returns worklog details for a list of issue ID and worklog ID pairs. This is an internal API for bulk fetching...
issue — This resource represents Jira issues. Use it to:
- create or edit issues, individually or in bulk.
- retrieve metadata about the options for creating or editing issues.
- delete an issue.
- assign a user to an issue.
- get issue changelogs.
- send notifications about an issue.
- get details of the transitions available for an issue.
- transition an issue.
- Archive issues.
- Unarchive issues.
- Export archived issues.
jira-pp-cli issue archive — Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the...
jira-pp-cli issue archive-async — Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status...
jira-pp-cli issue bulk-delete-property — Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The...
jira-pp-cli issue bulk-fetch — Returns the details for a set of requested issues. You can request up to 100 issues. Each issue is identified by its...
jira-pp-cli issue bulk-set-properties-by — Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up...
jira-pp-cli issue bulk-set-properties-list — Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified...
jira-pp-cli issue bulk-set-property — Sets a property value on multiple issues. The value set can be a constant or determined by a [Jira...
jira-pp-cli issue create — Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied,...
jira-pp-cli issue create-bulk — Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be...
jira-pp-cli issue delete — Deletes an issue. An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set...
jira-pp-cli issue edit — Edits an issue. Issue properties may be updated as part of the edit. Please note that issue transition is not...
jira-pp-cli issue get — Returns the details for an issue. The issue is identified by its ID or key, however, if the identifier doesn't match...
jira-pp-cli issue get-create-meta — Returns details of projects, issue types within projects, and, when requested, the create screen fields for each...
jira-pp-cli issue get-create-meta-type-id — Returns a page of field metadata for a specified project and issuetype id. Use the information to populate the...
jira-pp-cli issue get-create-meta-types — Returns a page of issue type metadata for a specified project. Use the information to populate the requests in [...
jira-pp-cli issue get-is-watching-bulk — Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned...
jira-pp-cli issue get-limit-report — Returns all issues breaching and approaching per-issue limits. Permissions required: * *Browse...
jira-pp-cli issue get-picker-resource — Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the...
jira-pp-cli issue unarchive — Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the...
issue-link — This resource represents links between issues. Use it to get, create, and delete links between issues.
To use it, the site must have issue linking enabled.
jira-pp-cli issue-link delete — Deletes an issue link. This operation can be accessed anonymously. Permissions required: *...
jira-pp-cli issue-link get — Returns an issue link. This operation can be accessed anonymously. Permissions required: *...
jira-pp-cli issue-link link-issues — Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally...
issue-link-type — This resource represents issue link types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.
To use it, the site must have issue linking enabled.
jira-pp-cli issue-link-type create — Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The...
jira-pp-cli issue-link-type delete — Deletes an issue link type. To use this operation, the site must have [issue...
jira-pp-cli issue-link-type get — Returns a list of all issue link types. To use this operation, the site must have [issue...
jira-pp-cli issue-link-type get-issuelinktype — Returns an issue link type. To use this operation, the site must have [issue...
jira-pp-cli issue-link-type update — Updates an issue link type. To use this operation, the site must have [issue...
issues — This resource represents Jira issues. Use it to:
- create or edit issues, individually or in bulk.
- retrieve metadata about the options for creating or editing issues.
- delete an issue.
- assign a user to an issue.
- get issue changelogs.
- send notifications about an issue.
- get details of the transitions available for an issue.
- transition an issue.
- Archive issues.
- Unarchive issues.
- Export archived issues.
jira-pp-cli issues — Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it...
issuesecurityschemes — Manage issuesecurityschemes
jira-pp-cli issuesecurityschemes associate-schemes-to-projects — Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if...
jira-pp-cli issuesecurityschemes create-issue-security-scheme — Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme...
jira-pp-cli issuesecurityschemes delete-security-scheme — Deletes an issue security scheme. Permissions required: Administer Jira [global...
jira-pp-cli issuesecurityschemes get-issue-security-scheme — Returns an issue security scheme along with its security levels. Permissions required: *...
jira-pp-cli issuesecurityschemes get-issue-security-schemes — Returns all issue security schemes. **Permissions...
jira-pp-cli issuesecurityschemes get-security-level-members — Returns a paginated list of issue security level members. Only issue security level members in the...
jira-pp-cli issuesecurityschemes get-security-levels — Returns a paginated list of issue security levels. Only issue security levels in the context of...
jira-pp-cli issuesecurityschemes search-projects-using-security-schemes — Returns a paginated mapping of projects that are using security schemes. You can provide either one...
jira-pp-cli issuesecurityschemes search-security-schemes — Returns a paginated list of issue security schemes. If you specify the project ID parameter, the...
jira-pp-cli issuesecurityschemes set-default-levels — Sets default issue security levels for schemes. Permissions required: Administer Jira [global...
jira-pp-cli issuesecurityschemes update-issue-security-scheme — Updates the issue security scheme. Permissions required: Administer Jira [global...
issuetype — Manage issuetype
jira-pp-cli issuetype create-issue-type — Creates an issue type. Permissions required: Administer Jira [global...
jira-pp-cli issuetype delete-issue-type — Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type...
jira-pp-cli issuetype get-issue-all-types — Returns all issue types. This operation can be accessed anonymously. Permissions required: Issue...
jira-pp-cli issuetype get-issue-type — Returns an issue type. This operation can be accessed anonymously. Permissions required: *Browse...
jira-pp-cli issuetype get-issue-types-for-project — Returns issue types for a project. This operation can be accessed anonymously. **Permissions...
jira-pp-cli issuetype update-issue-type — Updates the issue type. Permissions required: Administer Jira [global...
issuetypescheme — Manage issuetypescheme
jira-pp-cli issuetypescheme assign-issue-type-scheme-to-project — Assigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the...
jira-pp-cli issuetypescheme create-issue-type-scheme — Creates an issue type scheme. Permissions required: Administer Jira [global...
jira-pp-cli issuetypescheme delete-issue-type-scheme — Deletes an issue type scheme. Only issue type schemes used in classic projects can be deleted. Only issue type...
jira-pp-cli issuetypescheme get-all-issue-type-schemes — Returns a paginated list of issue type schemes. Only issue type schemes used in classic projects are...
jira-pp-cli issuetypescheme get-issue-type-scheme-for-projects — Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the...
jira-pp-cli issuetypescheme get-issue-type-schemes-mapping — Returns a paginated list of issue type scheme items. Only issue type scheme items used in classic...
jira-pp-cli issuetypescheme update-issue-type-scheme — Updates an issue type scheme. Permissions required: Administer Jira [global...
issuetypescreenscheme — Manage issuetypescreenscheme
jira-pp-cli issuetypescreenscheme assign-issue-type-screen-scheme-to-project — Assigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic...
jira-pp-cli issuetypescreenscheme create-issue-type-screen-scheme — Creates an issue type screen scheme. Permissions required: Administer Jira [global...
jira-pp-cli issuetypescreenscheme delete-issue-type-screen-scheme — Deletes an issue type screen scheme. Permissions required: Administer Jira [global...
jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-mappings — Returns a paginated list of issue type screen scheme items. Only issue type screen schemes used in...
jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-project-associations — Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list...
jira-pp-cli issuetypescreenscheme get-issue-type-screen-schemes — Returns a paginated list of issue type screen schemes. Only issue type screen schemes used in classic...
jira-pp-cli issuetypescreenscheme update-issue-type-screen-scheme — Updates an issue type screen scheme. Permissions required: Administer Jira [global...
jira-search — Manage jira cloud platform search
jira-pp-cli jira-search and-reconsile-issues-using-jql — Searches for issues using JQL. Recent updates might not be immediately...
jira-pp-cli jira-search and-reconsile-issues-using-jql-post — Searches for issues using JQL. Recent updates might not be immediately...
jira-pp-cli jira-search count-issues — Provide an estimated count of the issues that match the JQL. Recent...
jira-pp-cli jira-search for-issues-using-jql — Endpoint is currently being removed. More details Searches...
jira-pp-cli jira-search for-issues-using-jql-post — Endpoint is currently being removed. More details Searches...
jira-version — Manage jira cloud platform version
jira-pp-cli jira-version create — Creates a project version. This operation can be accessed anonymously. Permissions required:...
jira-pp-cli jira-version delete — Deletes a project version. Deprecated, use [ Delete and replace...
jira-pp-cli jira-version get — Returns a project version. This operation can be accessed anonymously. Permissions required:...
jira-pp-cli jira-version update — Updates a project version. This operation can be accessed anonymously. Permissions required:...
jira-workflow — Manage jira cloud platform workflow
jira-pp-cli jira-workflow create-transition-property — This will be removed on June 1, 2026;...
jira-pp-cli jira-workflow delete-inactive — Deletes a workflow. The workflow cannot be deleted if it is: * an active workflow. * a system workflow. * associated...
jira-pp-cli jira-workflow delete-transition-property — This will be removed on June 1, 2026;...
jira-pp-cli jira-workflow delete-transition-rule-configurations — Deletes workflow transition rules from one or more workflows. These rule types are supported: * [post...
jira-pp-cli jira-workflow get-paginated — This will be removed on June 1, 2026;...
jira-pp-cli jira-workflow get-transition-properties — This will be removed on June 1, 2026;...
jira-pp-cli jira-workflow get-transition-rule-configurations — Returns a paginated list of workflows with transition rules. The workflows can be filtered to return...
jira-pp-cli jira-workflow list-history — Returns a list of workflow history entries for a specified workflow id. Note: Stored workflow data expires after...
jira-pp-cli jira-workflow read-from-history — Returns a workflow and related statuses for a specified workflow id and version number. Note: Stored workflow...
jira-pp-cli jira-workflow update-transition-property — This will be removed on June 1, 2026;...
jira-pp-cli jira-workflow update-transition-rule-configurations — Updates configuration of workflow transition rules. The following rule types are supported: * [post...
jql — This resource represents JQL search auto-complete details. Use it
…(truncated)
1---
2name: pp-jira
3description: "Printing Press CLI for Jira Cloud Platform. Jira Cloud Platform REST API documentation"
4author: "Nikica Jokic"
5license: "Apache-2.0"
6argument-hint: "<command> [args] | install cli|mcp"
7allowed-tools: "Read Bash"
8metadata:
9 source: https://skillmd.com/skills/mvanhorn-printing-press-libra/pp-jira
10 openclaw:
11 requires:
12 bins:
13 - jira-pp-cli
14---
15<!-- GENERATED FILE — DO NOT EDIT.
16 This file is a verbatim mirror of library/project-management/jira/SKILL.md,
17 regenerated post-merge by tools/generate-skills/. Hand-edits here are
18 silently overwritten on the next regen. Edit the library/ source instead.
19 See the repository agent guide, section "Generated artifacts: registry.json, cli-skills/". -->
20
21# Jira Cloud Platform — Printing Press CLI
22
23## Prerequisites: Install the CLI
24
25This skill drives the `jira-pp-cli` binary. **You must verify the CLI is installed before invoking any command from this skill.** If it is missing, install it first:
26
271. Install via the Printing Press installer. It defaults binaries to `$HOME/.local/bin` on macOS/Linux and `%LOCALAPPDATA%\Programs\PrintingPress\bin` on Windows:
28 ```bash
29 npx -y @mvanhorn/printing-press-library install jira --cli-only
30 ```
312. Verify: `jira-pp-cli --version`
323. Ensure the reported install directory is on `$PATH` for the agent/runtime that will invoke this skill.
33
34If the `npx` install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer):
35
36```bash
37go install github.com/mvanhorn/printing-press-library/library/project-management/jira/cmd/jira-pp-cli@latest
38```
39
40If `--version` reports "command not found" after install, the runtime cannot see the binary directory on `$PATH`. Do not proceed with skill commands until verification succeeds.
41
42## Command Reference
43
44**announcement-banner** — This resource represents an announcement banner. Use it to retrieve and update banner configuration.
45
46- `jira-pp-cli announcement-banner get-banner` — Returns the current announcement banner configuration. **[Permissions](#permissions) required:** *Administer Jira*...
47- `jira-pp-cli announcement-banner set-banner` — Updates the announcement banner configuration. **[Permissions](#permissions) required:** *Administer Jira* [global...
48
49**app** — Manage app
50
51- `jira-pp-cli app get-custom-field-configuration` — Returns a [paginated](#pagination) list of configurations for a custom field of a...
52- `jira-pp-cli app get-custom-fields-configurations` — Returns a [paginated](#pagination) list of configurations for list of custom fields of a...
53- `jira-pp-cli app update-custom-field-configuration` — Update the configuration for contexts of a custom field of a [type](https://developer.atlassian.com/platform/forge/ma...
54- `jira-pp-cli app update-custom-field-value` — Updates the value of a custom field on one or more issues. Apps can only perform this operation on [custom...
55- `jira-pp-cli app update-multiple-custom-field-values` — Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should...
56
57**application-properties** — Manage application properties
58
59- `jira-pp-cli application-properties get-advanced-settings` — Returns the application properties that are accessible on the *Advanced Settings* page. To navigate to the *Advanced...
60- `jira-pp-cli application-properties get-application-property` — Returns all application properties or an application property. If you specify a value for the `key` parameter, then...
61- `jira-pp-cli application-properties set-application-property` — Changes the value of an application property. For example, you can change the value of the `jira.clone.prefix` from...
62
63**applicationrole** — Manage applicationrole
64
65- `jira-pp-cli applicationrole get-all-application-roles` — Returns all application roles. In Jira, application roles are managed using the [Application access...
66- `jira-pp-cli applicationrole get-application-role` — Returns an application role. **[Permissions](#permissions) required:** *Administer Jira* [global...
67
68**atlassian-connect** — Manage atlassian connect
69
70- `jira-pp-cli atlassian-connect addon-properties-resource-delete-addon-property-delete` — Deletes an app's property. **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey`...
71- `jira-pp-cli atlassian-connect addon-properties-resource-get-addon-properties-get` — Gets all the properties of an app. The reserved key `connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8` is not...
72- `jira-pp-cli atlassian-connect addon-properties-resource-get-addon-property-get` — Returns the key and value of an app's property. The property key...
73- `jira-pp-cli atlassian-connect addon-properties-resource-put-addon-property-put` — Sets the value of an app's property. Use this resource to store custom data for your app. The value of the request...
74- `jira-pp-cli atlassian-connect app-issue-field-value-update-resource-update-issue-fields-put` — Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom...
75- `jira-pp-cli atlassian-connect connect-to-forge-migration-fetch-task-resource-fetch-migration-task-get` — Returns the details of a Connect issue field's migration to Forge. When migrating a Connect app to Forge, [Issue...
76- `jira-pp-cli atlassian-connect connect-to-forge-migration-task-submission-resource-submit-task-post` — Submits a request to trigger migration of connect issue field to its Forge custom field counterpart. When migrating...
77- `jira-pp-cli atlassian-connect dynamic-modules-resource-get-modules-get` — Returns all modules registered dynamically by the calling app. **[Permissions](#permissions) required:** Only...
78- `jira-pp-cli atlassian-connect dynamic-modules-resource-register-modules-post` — Registers a list of modules. **[Permissions](#permissions) required:** Only Connect apps can make this request.
79- `jira-pp-cli atlassian-connect dynamic-modules-resource-remove-modules-delete` — Remove all or a list of modules registered by the calling app. **[Permissions](#permissions) required:** Only...
80- `jira-pp-cli atlassian-connect migration-resource-update-entity-properties-value-put` — Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for...
81- `jira-pp-cli atlassian-connect migration-resource-workflow-rule-search-post` — Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.
82- `jira-pp-cli atlassian-connect service-registry-resource-services-get` — Retrieve the attributes of given service registries. **[Permissions](#permissions) required:** Only Connect apps can...
83
84**attachment** — Manage attachment
85
86- `jira-pp-cli attachment get` — Returns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be...
87- `jira-pp-cli attachment get-content` — Returns the contents of an attachment. A `Range` header can be set to define a range of bytes within the attachment...
88- `jira-pp-cli attachment get-meta` — Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed....
89- `jira-pp-cli attachment get-thumbnail` — Returns the thumbnail of an attachment. To return the attachment contents, use [Get attachment...
90- `jira-pp-cli attachment remove` — Deletes an attachment from an issue. This operation can be accessed anonymously. **[Permissions](#permissions)...
91
92**auditing** — Manage auditing
93
94- `jira-pp-cli auditing` — Returns a list of audit records. The list can be filtered to include items: * where each item in `filter` has at...
95
96**avatar** — This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project, issue type or priority and obtain avatar images.
97
98
99**bulk** — Manage bulk
100
101- `jira-pp-cli bulk get-available-transitions` — Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk...
102- `jira-pp-cli bulk get-editable-fields` — Use this API to get a list of fields visible to the user to perform bulk edit operations. You can pass single or...
103- `jira-pp-cli bulk get-operation-progress` — Use this to get the progress state for the specified bulk operation `taskId`. **[Permissions](#permissions)...
104- `jira-pp-cli bulk submit-delete` — Use this API to submit a bulk delete request. You can delete up to 1,000 issues in a single operation....
105- `jira-pp-cli bulk submit-edit` — Use this API to submit a bulk edit request and simultaneously edit multiple issues. There are limits applied to the...
106- `jira-pp-cli bulk submit-move` — Use this API to submit a bulk issue move request. You can move multiple issues from multiple projects in a single...
107- `jira-pp-cli bulk submit-transition` — Use this API to submit a bulk issue status transition request. You can transition multiple issues, alongside with...
108- `jira-pp-cli bulk submit-unwatch` — Use this API to submit a bulk unwatch request. You can unwatch up to 1,000 issues in a single operation....
109- `jira-pp-cli bulk submit-watch` — Use this API to submit a bulk watch request. You can watch up to 1,000 issues in a single operation....
110
111**changelog** — Manage changelog
112
113- `jira-pp-cli changelog` — Bulk fetch changelogs for multiple issues and filter by fields Returns a paginated list of all changelogs for given...
114
115**classification-levels** — This resource represents classification levels.
116
117- `jira-pp-cli classification-levels` — Returns all classification levels. **[Permissions](#permissions) required:** None.
118
119**comment** — Manage comment
120
121- `jira-pp-cli comment` — Returns a [paginated](#pagination) list of comments specified by a list of comment IDs. This operation can be...
122
123**component** — Manage component
124
125- `jira-pp-cli component create` — Creates a component. Use components to provide containers for issues within a project. Use components to provide...
126- `jira-pp-cli component delete` — Deletes a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:**...
127- `jira-pp-cli component find-for-projects` — Returns a [paginated](#pagination) list of all components in a project, including global (Compass) components when...
128- `jira-pp-cli component get` — Returns a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse...
129- `jira-pp-cli component update` — Updates a component. Any fields included in the request are overwritten. If `leadAccountId` is an empty string ('')...
130
131**config** — Manage config
132
133- `jira-pp-cli config associate-projects-to-field-association-schemes` — Associate projects to field association schemes. **[Permissions](#permissions) required:** *Administer Jira* [global...
134- `jira-pp-cli config clone-field-association-scheme` — Endpoint for cloning an existing field association scheme into a new one. **[Permissions](#permissions) required:**...
135- `jira-pp-cli config create-field-association-scheme` — Endpoint for creating a new field association scheme. **[Permissions](#permissions) required:** *Administer Jira*...
136- `jira-pp-cli config delete-field-association-scheme` — Delete a specified field association scheme **[Permissions](#permissions) required:** *Administer Jira* [global...
137- `jira-pp-cli config get-field-association-scheme-by-id` — Endpoint for fetching a field association scheme by its ID **[Permissions](#permissions) required:** *Administer...
138- `jira-pp-cli config get-field-association-scheme-item-parameters` — Retrieve field association parameters on a field association scheme **[Permissions](#permissions) required:**...
139- `jira-pp-cli config get-field-association-schemes` — REST endpoint for retrieving a paginated list of field association schemes with optional filtering. This endpoint...
140- `jira-pp-cli config get-projects-with-field-schemes` — Get projects with field association schemes. This will be a temporary API but useful when transitioning from the...
141- `jira-pp-cli config remove-field-association-scheme-item-parameters` — Remove field association parameters overrides for work types. **[Permissions](#permissions) required:** *Administer...
142- `jira-pp-cli config remove-fields-associated-with-schemes` — Remove fields associated with field association schemes. **[Permissions](#permissions) required:** *Administer Jira*...
143- `jira-pp-cli config search-field-association-scheme-fields` — Search for fields belonging to a given field association scheme. **[Permissions](#permissions) required:**...
144- `jira-pp-cli config search-field-association-scheme-projects` — REST Endpoint for searching for projects belonging to a given field association scheme **[Permissions](#permissions)...
145- `jira-pp-cli config update-field-association-scheme` — Endpoint for updating an existing field association scheme. **[Permissions](#permissions) required:** *Administer...
146- `jira-pp-cli config update-field-association-scheme-item-parameters` — Update field association item parameters in field association schemes. **[Permissions](#permissions) required:**...
147- `jira-pp-cli config update-fields-associated-with-schemes` — Update fields associated with field association schemes. **[Permissions](#permissions) required:** *Administer Jira*...
148
149**configuration** — Manage configuration
150
151- `jira-pp-cli configuration get` — Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether...
152- `jira-pp-cli configuration get-available-time-tracking-implementations` — Returns all time tracking providers. By default, Jira only has one time tracking provider: *JIRA provided time...
153- `jira-pp-cli configuration get-selected-time-tracking-implementation` — Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a...
154- `jira-pp-cli configuration get-shared-time-tracking` — Returns the time tracking settings. This includes settings such as the time format, default time unit, and others....
155- `jira-pp-cli configuration select-time-tracking-implementation` — Selects a time tracking provider. **[Permissions](#permissions) required:** *Administer Jira* [global...
156- `jira-pp-cli configuration set-shared-time-tracking` — Sets the time tracking settings. **[Permissions](#permissions) required:** *Administer Jira* [global...
157
158**custom-field-option** — Manage custom field option
159
160- `jira-pp-cli custom-field-option <id>` — Returns a custom field option. For example, an option in a select list. Note that this operation **only works for...
161
162**dashboard** — This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards.
163
164- `jira-pp-cli dashboard bulk-edit` — Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100....
165- `jira-pp-cli dashboard create` — Creates a dashboard. **[Permissions](#permissions) required:** None.
166- `jira-pp-cli dashboard delete` — Deletes a dashboard. **[Permissions](#permissions) required:** None The dashboard to be deleted must be owned by the...
167- `jira-pp-cli dashboard get` — Returns a dashboard. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None....
168- `jira-pp-cli dashboard get-all` — Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or...
169- `jira-pp-cli dashboard get-all-available-gadgets` — Gets a list of all available gadgets that can be added to all dashboards. **[Permissions](#permissions) required:**...
170- `jira-pp-cli dashboard get-paginated` — Returns a [paginated](#pagination) list of dashboards. This operation is similar to [Get...
171- `jira-pp-cli dashboard update` — Updates a dashboard, replacing all the dashboard details with those provided. **[Permissions](#permissions)...
172
173**data-policy** — Manage data policy
174
175- `jira-pp-cli data-policy get-policies` — Returns data policies for the projects specified in the request.
176- `jira-pp-cli data-policy get-policy` — Returns data policy for the workspace.
177
178**events** — Manage events
179
180- `jira-pp-cli events` — Returns all issue events. **[Permissions](#permissions) required:** *Administer Jira* [global...
181
182**expression** — Manage expression
183
184- `jira-pp-cli expression analyse` — Analyses and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check...
185- `jira-pp-cli expression evaluate-jira` — Endpoint is currently being removed. [More details](https://developer.atlassian.com/changelog/#CHANGE-2046)...
186- `jira-pp-cli expression evaluate-jsisjira` — Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint uses...
187
188**field** — Manage field
189
190- `jira-pp-cli field create-associations` — Associates fields with projects. Fields will be associated with each issue type on the requested projects. Fields...
191- `jira-pp-cli field create-custom` — Creates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global...
192- `jira-pp-cli field delete-custom` — Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom...
193- `jira-pp-cli field get` — Returns system and custom issue fields according to the following rules: * Fields that cannot be added to the issue...
194- `jira-pp-cli field get-paginated` — Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include: * all fields *...
195- `jira-pp-cli field get-trashed-paginated` — Returns a [paginated](#pagination) list of fields in the trash. The list may be restricted to fields whose field...
196- `jira-pp-cli field remove-associations` — Unassociates a set of fields with a project and issue type context. Fields will be unassociated with all...
197- `jira-pp-cli field update-custom` — Updates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global...
198
199**fieldconfiguration** — Manage fieldconfiguration
200
201- `jira-pp-cli fieldconfiguration create-field-configuration` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
202- `jira-pp-cli fieldconfiguration delete-field-configuration` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
203- `jira-pp-cli fieldconfiguration get-all-field-configurations` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
204- `jira-pp-cli fieldconfiguration update-field-configuration` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
205
206**fieldconfigurationscheme** — Manage fieldconfigurationscheme
207
208- `jira-pp-cli fieldconfigurationscheme assign-field-configuration-scheme-to-project` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
209- `jira-pp-cli fieldconfigurationscheme create-field-configuration-scheme` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
210- `jira-pp-cli fieldconfigurationscheme delete-field-configuration-scheme` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
211- `jira-pp-cli fieldconfigurationscheme get-all-field-configuration-schemes` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
212- `jira-pp-cli fieldconfigurationscheme get-field-configuration-scheme-mappings` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
213- `jira-pp-cli fieldconfigurationscheme get-field-configuration-scheme-project-mapping` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
214- `jira-pp-cli fieldconfigurationscheme update-field-configuration-scheme` — Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
215
216**filter** — This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.
217
218- `jira-pp-cli filter create` — Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The...
219- `jira-pp-cli filter delete` — Delete a filter. **[Permissions](#permissions) required:** Permission to access Jira, however filters can only be...
220- `jira-pp-cli filter get` — Returns a filter. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None,...
221- `jira-pp-cli filter get-default-share-scope` — Returns the default sharing settings for new filters and dashboards for a user. **[Permissions](#permissions)...
222- `jira-pp-cli filter get-favourite` — Returns the visible favorite filters of the user. This operation can be accessed anonymously....
223- `jira-pp-cli filter get-my` — Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are...
224- `jira-pp-cli filter get-paginated` — Returns a [paginated](#pagination) list of filters. Use this operation to get: * specific filters, by defining `id`...
225- `jira-pp-cli filter set-default-share-scope` — Sets the default sharing for new filters and dashboards for a user. **[Permissions](#permissions) required:**...
226- `jira-pp-cli filter update` — Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing....
227
228**forge** — Manage forge
229
230- `jira-pp-cli forge bulk-pin-unpin-projects-async` — Bulk pin or unpin an issue panel (added by a Forge app) to or from multiple projects. The operation runs...
231- `jira-pp-cli forge delete-app-property` — Deletes a Forge app's property. **[Permissions](#permissions) required:** Only Forge apps can make this request....
232- `jira-pp-cli forge get-app-property` — Returns the value of a Forge app's property. **[Permissions](#permissions) required:** Only Forge apps can make this...
233- `jira-pp-cli forge get-app-property-keys` — Returns all property keys for the Forge app. **[Permissions](#permissions) required:** Only Forge apps can make this...
234- `jira-pp-cli forge put-app-property` — Sets the value of a Forge app's property. These values can be retrieved in [Jira...
235
236**group** — This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\[WARNING\] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)
237
238- `jira-pp-cli group add-user-to` — Adds a user to a group. **[Permissions](#permissions) required:** Site administration (that is, member of the...
239- `jira-pp-cli group bulk-get` — Returns a [paginated](#pagination) list of groups. **[Permissions](#permissions) required:** *Browse users and...
240- `jira-pp-cli group create` — Creates a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin*...
241- `jira-pp-cli group get` — This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get). Returns all users in a group....
242- `jira-pp-cli group get-users-from` — Returns a [paginated](#pagination) list of all users in a group. Note that users are ordered by username, however...
243- `jira-pp-cli group remove` — Deletes a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin*...
244- `jira-pp-cli group remove-user-from` — Removes a user from a group. **[Permissions](#permissions) required:** Site administration (that is, member of the...
245
246**groups** — This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\[WARNING\] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)
247
248- `jira-pp-cli groups` — Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups...
249
250**groupuserpicker** — Manage groupuserpicker
251
252- `jira-pp-cli groupuserpicker` — Returns a list of users and groups matching a string. The string is used: * for users, to find a case-insensitive...
253
254**instance** — Manage instance
255
256- `jira-pp-cli instance` — Returns licensing information about the Jira instance. **[Permissions](#permissions) required:** None.
257
258**internal** — Manage internal
259
260- `jira-pp-cli internal` — Returns worklog details for a list of issue ID and worklog ID pairs. This is an internal API for bulk fetching...
261
262**issue** — This resource represents Jira issues. Use it to:
263
264 * create or edit issues, individually or in bulk.
265 * retrieve metadata about the options for creating or editing issues.
266 * delete an issue.
267 * assign a user to an issue.
268 * get issue changelogs.
269 * send notifications about an issue.
270 * get details of the transitions available for an issue.
271 * transition an issue.
272 * Archive issues.
273 * Unarchive issues.
274 * Export archived issues.
275
276- `jira-pp-cli issue archive` — Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the...
277- `jira-pp-cli issue archive-async` — Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status...
278- `jira-pp-cli issue bulk-delete-property` — Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The...
279- `jira-pp-cli issue bulk-fetch` — Returns the details for a set of requested issues. You can request up to 100 issues. Each issue is identified by its...
280- `jira-pp-cli issue bulk-set-properties-by` — Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up...
281- `jira-pp-cli issue bulk-set-properties-list` — Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified...
282- `jira-pp-cli issue bulk-set-property` — Sets a property value on multiple issues. The value set can be a constant or determined by a [Jira...
283- `jira-pp-cli issue create` — Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied,...
284- `jira-pp-cli issue create-bulk` — Creates upto **50** issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be...
285- `jira-pp-cli issue delete` — Deletes an issue. An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set...
286- `jira-pp-cli issue edit` — Edits an issue. Issue properties may be updated as part of the edit. Please note that issue transition is not...
287- `jira-pp-cli issue get` — Returns the details for an issue. The issue is identified by its ID or key, however, if the identifier doesn't match...
288- `jira-pp-cli issue get-create-meta` — Returns details of projects, issue types within projects, and, when requested, the create screen fields for each...
289- `jira-pp-cli issue get-create-meta-type-id` — Returns a page of field metadata for a specified project and issuetype id. Use the information to populate the...
290- `jira-pp-cli issue get-create-meta-types` — Returns a page of issue type metadata for a specified project. Use the information to populate the requests in [...
291- `jira-pp-cli issue get-is-watching-bulk` — Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned...
292- `jira-pp-cli issue get-limit-report` — Returns all issues breaching and approaching per-issue limits. **[Permissions](#permissions) required:** * *Browse...
293- `jira-pp-cli issue get-picker-resource` — Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the...
294- `jira-pp-cli issue unarchive` — Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the...
295
296**issue-link** — This resource represents links between issues. Use it to get, create, and delete links between issues.
297
298To use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
299
300- `jira-pp-cli issue-link delete` — Deletes an issue link. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *...
301- `jira-pp-cli issue-link get` — Returns an issue link. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *...
302- `jira-pp-cli issue-link link-issues` — Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally...
303
304**issue-link-type** — This resource represents [issue link](#api-group-Issue-links) types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.
305
306To use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
307
308- `jira-pp-cli issue-link-type create` — Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The...
309- `jira-pp-cli issue-link-type delete` — Deletes an issue link type. To use this operation, the site must have [issue...
310- `jira-pp-cli issue-link-type get` — Returns a list of all issue link types. To use this operation, the site must have [issue...
311- `jira-pp-cli issue-link-type get-issuelinktype` — Returns an issue link type. To use this operation, the site must have [issue...
312- `jira-pp-cli issue-link-type update` — Updates an issue link type. To use this operation, the site must have [issue...
313
314**issues** — This resource represents Jira issues. Use it to:
315
316 * create or edit issues, individually or in bulk.
317 * retrieve metadata about the options for creating or editing issues.
318 * delete an issue.
319 * assign a user to an issue.
320 * get issue changelogs.
321 * send notifications about an issue.
322 * get details of the transitions available for an issue.
323 * transition an issue.
324 * Archive issues.
325 * Unarchive issues.
326 * Export archived issues.
327
328- `jira-pp-cli issues` — Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it...
329
330**issuesecurityschemes** — Manage issuesecurityschemes
331
332- `jira-pp-cli issuesecurityschemes associate-schemes-to-projects` — Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if...
333- `jira-pp-cli issuesecurityschemes create-issue-security-scheme` — Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme...
334- `jira-pp-cli issuesecurityschemes delete-security-scheme` — Deletes an issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
335- `jira-pp-cli issuesecurityschemes get-issue-security-scheme` — Returns an issue security scheme along with its security levels. **[Permissions](#permissions) required:** *...
336- `jira-pp-cli issuesecurityschemes get-issue-security-schemes` — Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg). **[Permissions](#permissions)...
337- `jira-pp-cli issuesecurityschemes get-security-level-members` — Returns a [paginated](#pagination) list of issue security level members. Only issue security level members in the...
338- `jira-pp-cli issuesecurityschemes get-security-levels` — Returns a [paginated](#pagination) list of issue security levels. Only issue security levels in the context of...
339- `jira-pp-cli issuesecurityschemes search-projects-using-security-schemes` — Returns a [paginated](#pagination) mapping of projects that are using security schemes. You can provide either one...
340- `jira-pp-cli issuesecurityschemes search-security-schemes` — Returns a [paginated](#pagination) list of issue security schemes. If you specify the project ID parameter, the...
341- `jira-pp-cli issuesecurityschemes set-default-levels` — Sets default issue security levels for schemes. **[Permissions](#permissions) required:** *Administer Jira* [global...
342- `jira-pp-cli issuesecurityschemes update-issue-security-scheme` — Updates the issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
343
344**issuetype** — Manage issuetype
345
346- `jira-pp-cli issuetype create-issue-type` — Creates an issue type. **[Permissions](#permissions) required:** *Administer Jira* [global...
347- `jira-pp-cli issuetype delete-issue-type` — Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type...
348- `jira-pp-cli issuetype get-issue-all-types` — Returns all issue types. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issue...
349- `jira-pp-cli issuetype get-issue-type` — Returns an issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse...
350- `jira-pp-cli issuetype get-issue-types-for-project` — Returns issue types for a project. This operation can be accessed anonymously. **[Permissions](#permissions)...
351- `jira-pp-cli issuetype update-issue-type` — Updates the issue type. **[Permissions](#permissions) required:** *Administer Jira* [global...
352
353**issuetypescheme** — Manage issuetypescheme
354
355- `jira-pp-cli issuetypescheme assign-issue-type-scheme-to-project` — Assigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the...
356- `jira-pp-cli issuetypescheme create-issue-type-scheme` — Creates an issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
357- `jira-pp-cli issuetypescheme delete-issue-type-scheme` — Deletes an issue type scheme. Only issue type schemes used in classic projects can be deleted. Only issue type...
358- `jira-pp-cli issuetypescheme get-all-issue-type-schemes` — Returns a [paginated](#pagination) list of issue type schemes. Only issue type schemes used in classic projects are...
359- `jira-pp-cli issuetypescheme get-issue-type-scheme-for-projects` — Returns a [paginated](#pagination) list of issue type schemes and, for each issue type scheme, a list of the...
360- `jira-pp-cli issuetypescheme get-issue-type-schemes-mapping` — Returns a [paginated](#pagination) list of issue type scheme items. Only issue type scheme items used in classic...
361- `jira-pp-cli issuetypescheme update-issue-type-scheme` — Updates an issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
362
363**issuetypescreenscheme** — Manage issuetypescreenscheme
364
365- `jira-pp-cli issuetypescreenscheme assign-issue-type-screen-scheme-to-project` — Assigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic...
366- `jira-pp-cli issuetypescreenscheme create-issue-type-screen-scheme` — Creates an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
367- `jira-pp-cli issuetypescreenscheme delete-issue-type-screen-scheme` — Deletes an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
368- `jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-mappings` — Returns a [paginated](#pagination) list of issue type screen scheme items. Only issue type screen schemes used in...
369- `jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-project-associations` — Returns a [paginated](#pagination) list of issue type screen schemes and, for each issue type screen scheme, a list...
370- `jira-pp-cli issuetypescreenscheme get-issue-type-screen-schemes` — Returns a [paginated](#pagination) list of issue type screen schemes. Only issue type screen schemes used in classic...
371- `jira-pp-cli issuetypescreenscheme update-issue-type-screen-scheme` — Updates an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
372
373**jira-search** — Manage jira cloud platform search
374
375- `jira-pp-cli jira-search and-reconsile-issues-using-jql` — Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately...
376- `jira-pp-cli jira-search and-reconsile-issues-using-jql-post` — Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately...
377- `jira-pp-cli jira-search count-issues` — Provide an estimated count of the issues that match the [JQL](https://confluence.atlassian.com/x/egORLQ). Recent...
378- `jira-pp-cli jira-search for-issues-using-jql` — Endpoint is currently being removed. [More details](https://developer.atlassian.com/changelog/#CHANGE-2046) Searches...
379- `jira-pp-cli jira-search for-issues-using-jql-post` — Endpoint is currently being removed. [More details](https://developer.atlassian.com/changelog/#CHANGE-2046) Searches...
380
381**jira-version** — Manage jira cloud platform version
382
383- `jira-pp-cli jira-version create` — Creates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:**...
384- `jira-pp-cli jira-version delete` — Deletes a project version. Deprecated, use [ Delete and replace...
385- `jira-pp-cli jira-version get` — Returns a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:**...
386- `jira-pp-cli jira-version update` — Updates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:**...
387
388**jira-workflow** — Manage jira cloud platform workflow
389
390- `jira-pp-cli jira-workflow create-transition-property` — This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2570);...
391- `jira-pp-cli jira-workflow delete-inactive` — Deletes a workflow. The workflow cannot be deleted if it is: * an active workflow. * a system workflow. * associated...
392- `jira-pp-cli jira-workflow delete-transition-property` — This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2570);...
393- `jira-pp-cli jira-workflow delete-transition-rule-configurations` — Deletes workflow transition rules from one or more workflows. These rule types are supported: * [post...
394- `jira-pp-cli jira-workflow get-paginated` — This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2569);...
395- `jira-pp-cli jira-workflow get-transition-properties` — This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2570);...
396- `jira-pp-cli jira-workflow get-transition-rule-configurations` — Returns a [paginated](#pagination) list of workflows with transition rules. The workflows can be filtered to return...
397- `jira-pp-cli jira-workflow list-history` — Returns a list of workflow history entries for a specified workflow id. **Note:** Stored workflow data expires after...
398- `jira-pp-cli jira-workflow read-from-history` — Returns a workflow and related statuses for a specified workflow id and version number. **Note:** Stored workflow...
399- `jira-pp-cli jira-workflow update-transition-property` — This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2570);...
400- `jira-pp-cli jira-workflow update-transition-rule-configurations` — Updates configuration of workflow transition rules. The following rule types are supported: * [post...
401
402**jql** — This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom query builders. It also provides operations to:
403
404 * convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.
405 * convert readable details in one or more JQL queries to IDs where a user doesn't have permission to view the entity whose details are readable.
406
407- `jira-pp-cli jql get-auto-complete` — Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced...
408- `jira-pp-cli jql get-auto-complete-post` — Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced...
409- `jira-pp-cli jql get-field-auto-complete-for-query-string` — Returns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing: *...
410- `jira-pp-cli jql get-precomputations` — Returns the list of a function's precomputations along with information about when they were created, updated, and...
411- `jira-pp-cli jql get-precomputations-by-id` — Returns function precomputations by IDs, along with information about when they were created, updated, and last...
412- `jira-pp-cli jql match-issues` — Checks whether one or more issues would be returned by one or more JQL queries. **[Permissions](#permissions)...
413- `jira-pp-cli jql migrate-queries` — Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account...
414- `jira-pp-cli jql parse-queries` — Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be...
415- `jira-pp-cli jql sanitise-queries` — Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to...
416- `jira-pp-cli jql update-precomputations` — Update the precomputation value of a function created by a Forge/Connect app. **[Permissions](#permissions)...
417
418**label** — This resource represents available labels. Use it to get available labels for the global label field.
419
420- `jira-pp-cli label` — Returns a [paginated](#pagination) list of labels.
421
422**license** — Manage license
423
424- `jira-pp-cli license get-approximate-application-count` — Returns the total approximate number of user accounts for a single Jira license. Note that this information is...
425- `jira-pp-cli license get-approximate-count` — Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with...
426
427**mypermissions** — Manage mypermissions
428
429- `jira-pp-cli mypermissions` — Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be...
430
431**mypreferences** — Manage mypreferences
432
433- `jira-pp-cli mypreferences get-locale` — Returns the locale for the user. If the user has no language preference set (which is the default setting) or this...
434- `jira-pp-cli mypreferences get-preference` — Returns the value of a preference of the current user. Note that these keys are deprecated: * *jira.user.locale* The...
435- `jira-pp-cli mypreferences remove-preference` — Deletes a preference of the user, which restores the default value of system defined settings. Note that these keys...
436- `jira-pp-cli mypreferences set-locale` — Deprecated, use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-...
437- `jira-pp-cli mypreferences set-preference` — Creates a preference for the user or updates a preference's value by sending a plain text string. For example,...
438
439**myself** — This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, and delete (restore default) values of the user's preferences and locale.
440
441- `jira-pp-cli myself` — Returns details for the current user. **[Permissions](#permissions) required:** Permission to access Jira.
442
443**notificationscheme** — Manage notificationscheme
444
445- `jira-pp-cli notificationscheme create-notification-scheme` — Creates a notification scheme with notifications. You can create up to 1000 notifications per request....
446- `jira-pp-cli notificationscheme delete-notification-scheme` — Deletes a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
447- `jira-pp-cli notificationscheme get-notification-scheme` — Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the...
448- `jira-pp-cli notificationscheme get-notification-scheme-to-project-mappings` — Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide either...
449- `jira-pp-cli notificationscheme get-notification-schemes` — Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered...
450- `jira-pp-cli notificationscheme update-notification-scheme` — Updates a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
451
452**permissions** — This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.
453
454- `jira-pp-cli permissions get-all` — Returns all permissions, including: * global permissions. * project permissions. * global permissions added by...
455- `jira-pp-cli permissions get-bulk` — Returns: * for a list of global permissions, the global permissions granted to a user. * for a list of project...
456- `jira-pp-cli permissions get-permitted-projects` — Returns all the projects where the user is granted a list of project permissions. This operation can be accessed...
457
458**permissionscheme** — Manage permissionscheme
459
460- `jira-pp-cli permissionscheme create-permission-scheme` — Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission...
461- `jira-pp-cli permissionscheme delete-permission-scheme` — Deletes a permission scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
462- `jira-pp-cli permissionscheme get-all-permission-schemes` — Returns all permission schemes. ### About permission schemes and grants ### A permission scheme is a collection of...
463- `jira-pp-cli permissionscheme get-permission-scheme` — Returns a permission scheme. **[Permissions](#permissions) required:** Permission to access Jira.
464- `jira-pp-cli permissionscheme update-permission-scheme` — Updates a permission scheme. Below are some important things to note when using this resource: * If a permissions...
465
466**plans** — This resource represents plans. Use it to get, create, duplicate, update, trash and archive plans.
467
468- `jira-pp-cli plans add-atlassian-team` — Adds an existing Atlassian team to a plan and configures their plannning settings. **[Permissions](#permissions)...
469- `jira-pp-cli plans archive` — Archives a plan. **[Permissions](#permissions) required:** *Administer Jira* [global...
470- `jira-pp-cli plans create` — Creates a plan. **[Permissions](#permissions) required:** *Administer Jira* [global...
471- `jira-pp-cli plans create-only-team` — Creates a plan-only team and configures their planning settings. **[Permissions](#permissions) required:**...
472- `jira-pp-cli plans delete-only-team` — Deletes a plan-only team and their planning settings. **[Permissions](#permissions) required:** *Administer Jira*...
473- `jira-pp-cli plans duplicate` — Duplicates a plan. **[Permissions](#permissions) required:** *Administer Jira* [global...
474- `jira-pp-cli plans get` — Returns a [paginated](#pagination) list of plans. **[Permissions](#permissions) required:** *Administer Jira*...
475- `jira-pp-cli plans get-atlassian-team` — Returns planning settings for an Atlassian team in a plan. **[Permissions](#permissions) required:** *Administer...
476- `jira-pp-cli plans get-only-team` — Returns planning settings for a plan-only team. **[Permissions](#permissions) required:** *Administer Jira* [global...
477- `jira-pp-cli plans get-plan` — Returns a plan. **[Permissions](#permissions) required:** *Administer Jira* [global...
478- `jira-pp-cli plans get-teams` — Returns a [paginated](#pagination) list of plan-only and Atlassian teams in a plan. **[Permissions](#permissions)...
479- `jira-pp-cli plans remove-atlassian-team` — Removes an Atlassian team from a plan and deletes their planning settings. **[Permissions](#permissions) required:**...
480- `jira-pp-cli plans trash` — Moves a plan to trash. **[Permissions](#permissions) required:** *Administer Jira* [global...
481- `jira-pp-cli plans update` — Updates any of the following details of a plan using [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902). *...
482- `jira-pp-cli plans update-atlassian-team` — Updates any of the following planning settings of an Atlassian team in a plan using [JSON...
483- `jira-pp-cli plans update-only-team` — Updates any of the following planning settings of a plan-only team using [JSON...
484
485**priority** — Manage priority
486
487- `jira-pp-cli priority create` — Creates an issue priority. Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar...
488- `jira-pp-cli priority delete` — Deletes an issue priority. This operation is [asynchronous](#async). Follow the `location` link in the response to...
489- `jira-pp-cli priority get` — Returns an issue priority. **[Permissions](#permissions) required:** Permission to access Jira.
490- `jira-pp-cli priority get-priorities` — Returns the list of all issue priorities. **[Permissions](#permissions) required:** Permission to access Jira.
491- `jira-pp-cli priority move-priorities` — Changes the order of issue priorities. **[Permissions](#permissions) required:** *Administer Jira* [global...
492- `jira-pp-cli priority search-priorities` — Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined by...
493- `jira-pp-cli priority set-default` — Sets default issue priority. **[Permissions](#permissions) required:** *Administer Jira* [global...
494- `jira-pp-cli priority update` — Updates an issue priority. At least one request body parameter must be defined. Deprecation applies to iconUrl param...
495
496**priorityscheme** — Manage priorityscheme
497
498- `jira-pp-cli priorityscheme create-priority-scheme` — Creates a new priority scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
499- `jira-pp-cli priorityscheme delete-priority-scheme` — Deletes a priority scheme. This operation is only available for priority schemes without any associated projects....
500- `jira-pp-cli priorityscheme get-available-priorities-by-priority-scheme` — Returns a [paginated](#pagination) list of priorities available for adding to a priority scheme....
501- `jira-pp-cli priorityscheme get-priority-schemes` — Returns a [paginated](#pagination) list of priority schemes. **[Permissions](#permissions) required:** Permission to...
502- `jira-pp-cli priorityscheme suggested-priorities-for-mappings` — Returns a [paginated](#pagination) list of priorities that would require mapping, given a change in priorities or...
503- `jira-pp-cli priorityscheme update-priority-scheme` — Updates a priority scheme. This includes its details, the lists of priorities and projects in it...
504
505**project** — This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type.
506
507- `jira-pp-cli project create` — Creates a project based on a project type template, as shown in the following table: | Project Type Key | Project...
508- `jira-pp-cli project delete` — Deletes a project. You can't delete a project if it's archived. To delete an archived project, restore the project...
509- `jira-pp-cli project get` — Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project. This operation can be...
510- `jira-pp-cli project get-accessible-type-by-key` — Returns a [project type](https://confluence.atlassian.com/x/Var1Nw) if it is accessible to the user....
511- `jira-pp-cli project get-all` — Returns all projects visible to the user. Deprecated, use [ Get projects...
512- `jira-pp-cli project get-all-accessible-types` — Returns all [project types](https://confluence.atlassian.com/x/Var1Nw) with a valid license.
513- `jira-pp-cli project get-all-types` — Returns all [project types](https://confluence.atlassian.com/x/Var1Nw), whether or not the instance has a valid...
514- `jira-pp-cli project get-recent` — Returns a list of up to 20 projects recently viewed by the user that are still visible to the user. This operation...
515- `jira-pp-cli project get-type-by-key` — Returns a [project type](https://confluence.atlassian.com/x/Var1Nw). This operation can be accessed anonymously....
516- `jira-pp-cli project search` — Returns a [paginated](#pagination) list of projects visible to the user. This operation can be accessed anonymously....
517- `jira-pp-cli project update` — Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project. All parameters are optional...
518
519**project-category** — Manage project category
520
521- `jira-pp-cli project-category create` — Creates a project category. **[Permissions](#permissions) required:** *Administer Jira* [global...
522- `jira-pp-cli project-category get-all-project-categories` — Returns all project categories. **[Permissions](#permissions) required:** Permission to access Jira.
523- `jira-pp-cli project-category get-by-id` — Returns a project category. **[Permissions](#permissions) required:** Permission to access Jira.
524- `jira-pp-cli project-category remove` — Deletes a project category. **[Permissions](#permissions) required:** *Administer Jira* [global...
525- `jira-pp-cli project-category update` — Updates a project category. **[Permissions](#permissions) required:** *Administer Jira* [global...
526
527**project-template** — This resource represents project templates. Use it to create a new project from a custom template.
528
529- `jira-pp-cli project-template create-project-with-custom-template` — Creates a project based on a custom template provided in the request. The request body should contain the project...
530- `jira-pp-cli project-template edit-template` — Edit custom template This API endpoint allows you to edit an existing customised template. ***Note: Custom Templates...
531- `jira-pp-cli project-template live-template` — Get custom template This API endpoint allows you to get a live custom project template details by either templateKey...
532- `jira-pp-cli project-template remove-template` — Remove custom template This API endpoint allows you to remove a specified customised template ***Note: Custom...
533- `jira-pp-cli project-template save-template` — Save custom template This API endpoint allows you to save a customised template ***Note: Custom Templates are only...
534
535**projects** — This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type.
536
537- `jira-pp-cli projects` — Returns a [paginated](#pagination) list of fields for the requested projects and work types. Only fields that are...
538
539**projectvalidate** — Manage projectvalidate
540
541- `jira-pp-cli projectvalidate get-valid-project-key` — Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key....
542- `jira-pp-cli projectvalidate get-valid-project-name` — Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in...
543- `jira-pp-cli projectvalidate validate-project-key` — Validates a project key by confirming the key is a valid string and not in use. **[Permissions](#permissions)...
544
545**redact** — Manage redact
546
547- `jira-pp-cli redact get-redaction-status` — Retrieves the current status of a redaction job ID. The jobStatus will be one of the following: * IN_PROGRESS - The...
548- `jira-pp-cli redact redact` — Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields...
549
550**resolution** — Manage resolution
551
552- `jira-pp-cli resolution create` — Creates an issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global...
553- `jira-pp-cli resolution delete` — Deletes an issue resolution. This operation is [asynchronous](#async). Follow the `location` link in the response to...
554- `jira-pp-cli resolution get` — Returns a list of all issue resolution values. **[Permissions](#permissions) required:** Permission to access Jira.
555- `jira-pp-cli resolution get-id` — Returns an issue resolution value. **[Permissions](#permissions) required:** Permission to access Jira.
556- `jira-pp-cli resolution move` — Changes the order of issue resolutions. **[Permissions](#permissions) required:** *Administer Jira* [global...
557- `jira-pp-cli resolution search` — Returns a [paginated](#pagination) list of resolutions. The list can contain all resolutions or a subset determined...
558- `jira-pp-cli resolution set-default` — Sets default issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global...
559- `jira-pp-cli resolution update` — Updates an issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global...
560
561**role** — Manage role
562
563- `jira-pp-cli role create-project` — Creates a new project role with no [default actors](#api-rest-api-3-resolution-get). You can use the [Add default...
564- `jira-pp-cli role delete-project` — Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in...
565- `jira-pp-cli role fully-update-project` — Updates the project role's name and description. You must include both a name and a description in the request....
566- `jira-pp-cli role get-all-project` — Gets a list of all project roles, complete with project role details and default actors. ### About project roles ###...
567- `jira-pp-cli role get-project-by-id` — Gets the project role details and the default actors associated with the role. The list of default actors is sorted...
568- `jira-pp-cli role partial-update-project` — Updates either the project role's name or its description. You cannot update both the name and description at the...
569
570**screens** — This resource represents the screens used to record issue details. Use it to:
571
572 * get details of all screens.
573 * get details of all the fields available for use on screens.
574 * create screens.
575 * delete screens.
576 * update screens.
577 * add a field to the default screen.
578
579- `jira-pp-cli screens add-field-to-default` — Adds a field to the default tab of the default screen. **[Permissions](#permissions) required:** *Administer Jira*...
580- `jira-pp-cli screens create` — Creates a screen with a default field tab. **[Permissions](#permissions) required:** *Administer Jira* [global...
581- `jira-pp-cli screens delete` — Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. Only...
582- `jira-pp-cli screens get` — Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs....
583- `jira-pp-cli screens get-bulk-tabs` — Returns the list of tabs for a bulk of screens. **[Permissions](#permissions) required:** * *Administer Jira*...
584- `jira-pp-cli screens update` — Updates a screen. Only screens used in classic projects can be updated. **[Permissions](#permissions) required:**...
585
586**screenscheme** — Manage screenscheme
587
588- `jira-pp-cli screenscheme create-screen-scheme` — Creates a screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
589- `jira-pp-cli screenscheme delete-screen-scheme` — Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only...
590- `jira-pp-cli screenscheme get-screen-schemes` — Returns a [paginated](#pagination) list of screen schemes. Only screen schemes used in classic projects are...
591- `jira-pp-cli screenscheme update-screen-scheme` — Updates a screen scheme. Only screen schemes used in classic projects can be updated. **[Permissions](#permissions)...
592
593**securitylevel** — Manage securitylevel
594
595- `jira-pp-cli securitylevel <id>` — Returns details of an issue security level. Use [Get issue security...
596
597**server-info** — This resource provides information about the Jira instance.
598
599- `jira-pp-cli server-info` — Returns information about the Jira instance. This operation can be accessed anonymously....
600
601**settings** — Manage settings
602
603- `jira-pp-cli settings get-issue-navigator-default-columns` — Returns the default issue navigator columns. **[Permissions](#permissions) required:** *Administer Jira* [global...
604- `jira-pp-cli settings set-issue-navigator-default-columns` — Sets the default issue navigator columns. The `columns` parameter accepts a navigable field value and is expressed...
605
606**status** — This resource represents statuses. Use it to search, get, create, delete, and change statuses.
607
608- `jira-pp-cli status get` — Returns a status. The status must be associated with an active workflow to be returned. If a name is used on more...
609- `jira-pp-cli status get-statuses` — Returns a list of all statuses associated with active workflows. This operation can be accessed anonymously....
610
611**statuscategory** — Manage statuscategory
612
613- `jira-pp-cli statuscategory get-status-categories` — Returns a list of all status categories. **[Permissions](#permissions) required:** Permission to access Jira.
614- `jira-pp-cli statuscategory get-status-category` — Returns a status category. Status categories provided a mechanism for categorizing...
615
616**statuses** — Manage statuses
617
618- `jira-pp-cli statuses create` — Creates statuses for a global or project scope. **[Permissions](#permissions) required:** * *Administer projects*...
619- `jira-pp-cli statuses delete-by-id` — Deletes statuses by ID. **[Permissions](#permissions) required:** * *Administer projects* [project...
620- `jira-pp-cli statuses get-by-id` — Returns a list of the statuses specified by one or more status IDs. **[Permissions](#permissions) required:** *...
621- `jira-pp-cli statuses get-by-name` — Returns a list of the statuses specified by one or more status names. **[Permissions](#permissions) required:** *...
622- `jira-pp-cli statuses search` — Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of...
623- `jira-pp-cli statuses update` — Updates statuses by ID. **[Permissions](#permissions) required:** * *Administer projects* [project...
624
625**task** — This resource represents a [long-running asynchronous tasks](#async-operations). Use it to obtain details about the progress of a long-running task or cancel a long-running task.
626
627- `jira-pp-cli task <taskId>` — Returns the status of a [long-running asynchronous task](#async). When a task has finished, this operation returns...
628
629**ui-modifications** — Manage ui modifications
630
631- `jira-pp-cli ui-modifications create` — Creates a UI modification. UI modification can only be created by Forge apps. Each app can define up to 3000 UI...
632- `jira-pp-cli ui-modifications delete` — Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can...
633- `jira-pp-cli ui-modifications get` — Gets UI modifications. UI modifications can only be retrieved by Forge apps. **[Permissions](#permissions)...
634- `jira-pp-cli ui-modifications update` — Updates a UI modification. UI modification can only be updated by Forge apps. Each UI modification can define up to...
635
636**universal-avatar** — Manage universal avatar
637
638- `jira-pp-cli universal-avatar delete-avatar` — Deletes an avatar from a project, issue type or priority. **[Permissions](#permissions) required:** *Administer...
639- `jira-pp-cli universal-avatar get-avatar-image-by-id` — Returns a project, issue type or priority avatar image by ID. This operation can be accessed anonymously....
640- `jira-pp-cli universal-avatar get-avatar-image-by-owner` — Returns the avatar image for a project, issue type or priority. This operation can be accessed anonymously....
641- `jira-pp-cli universal-avatar get-avatar-image-by-type` — Returns the default project, issue type or priority avatar image. This operation can be accessed anonymously....
642- `jira-pp-cli universal-avatar get-avatars` — Returns the system and custom avatars for a project, issue type or priority. This operation can be accessed...
643- `jira-pp-cli universal-avatar store-avatar` — Loads a custom avatar for a project, issue type or priority. Specify the avatar's local file location in the body of...
644
645**user** — This resource represent users. Use it to:
646
647 * get, get a list of, create, and delete users.
648 * get, set, and reset a user's default issue table columns.
649 * get a list of the groups the user belongs to.
650 * get a list of user account IDs for a list of usernames or user keys.
651
652- `jira-pp-cli user bulk-get` — Returns a [paginated](#pagination) list of the users specified by one or more account IDs....
653- `jira-pp-cli user bulk-get-migration` — Returns the account IDs for the users specified in the `key` or `username` parameters. Note that multiple `key` or...
654- `jira-pp-cli user create` — Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is...
655- `jira-pp-cli user delete-property` — Deletes a property from a user. Note: This operation does not access the [user...
656- `jira-pp-cli user find` — Returns a list of active users that match the search string and property. This operation first applies a filter to...
657- `jira-pp-cli user find-assignable` — Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be...
658- `jira-pp-cli user find-bulk-assignable` — Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users...
659- `jira-pp-cli user find-by-query` — Finds users with a structured query and returns a [paginated](#pagination) list of user details. This operation...
660- `jira-pp-cli user find-for-picker` — Returns a list of users whose attributes match the query term. The returned object includes the `html` field where...
661- `jira-pp-cli user find-keys-by-query` — Finds users with a structured query and returns a [paginated](#pagination) list of user keys. This operation takes...
662- `jira-pp-cli user find-with-all-permissions` — Returns a list of users who fulfill these criteria: * their user attributes match a search string. * they have a set...
663- `jira-pp-cli user find-with-browse-permission` — Returns a list of users who fulfill these criteria: * their user attributes match a search string. * they have...
664- `jira-pp-cli user get` — Returns a user. Privacy controls are applied to the response based on the user's preferences. This could mean, for...
665- `jira-pp-cli user get-default-columns` — Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If `accountId` is...
666- `jira-pp-cli user get-email` — Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is...
667- `jira-pp-cli user get-email-bulk` — Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is...
668- `jira-pp-cli user get-groups` — Returns the groups to which a user belongs. **[Permissions](#permissions) required:** *Browse users and groups*...
669- `jira-pp-cli user get-property` — Returns the value of a user's property. If no property key is provided [Get user property...
670- `jira-pp-cli user get-property-keys` — Returns the keys of all properties for a user. Note: This operation does not access the [user...
671- `jira-pp-cli user remove` — Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This...
672- `jira-pp-cli user reset-columns` — Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system...
673- `jira-pp-cli user set-columns` — Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an account ID is...
674- `jira-pp-cli user set-property` — Sets the value of a user's property. Use this resource to store custom data against a user. Note: This operation...
675
676**users** — This resource represent users. Use it to:
677
678 * get, get a list of, create, and delete users.
679 * get, set, and reset a user's default issue table columns.
680 * get a list of the groups the user belongs to.
681 * get a list of user account IDs for a list of usernames or user keys.
682
683- `jira-pp-cli users get-all` — Returns a list of all users, including active users, inactive users and previously deleted users that have an...
684- `jira-pp-cli users get-all-default` — Returns a list of all users, including active users, inactive users and previously deleted users that have an...
685
686**webhook** — This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect and OAuth 2.0 apps can register and manage webhooks. For more information, see [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).
687
688- `jira-pp-cli webhook delete-by-id` — Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps...
689- `jira-pp-cli webhook get-dynamic-for-app` — Returns a [paginated](#pagination) list of the webhooks registered by the calling app. **[Permissions](#permissions)...
690- `jira-pp-cli webhook get-failed` — Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of...
691- `jira-pp-cli webhook refresh` — Extends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to...
692- `jira-pp-cli webhook register-dynamic` — Registers webhooks. **NOTE:** for non-public OAuth apps, webhooks are delivered only if there is a match between the...
693
694**workflows** — This resource represents workflows. Use it to:
695
696 * Get workflows
697 * Create workflows
698 * Update workflows
699 * Delete inactive workflows
700 * Get workflow capabilities
701
702- `jira-pp-cli workflows capabilities` — Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue...
703- `jira-pp-cli workflows create` — Create workflows and related statuses. **[Permissions](#permissions) required:** * *Administer Jira* project...
704- `jira-pp-cli workflows get-default-editor` — Get the user's default workflow editor. This can be either the new editor or the legacy editor.
705- `jira-pp-cli workflows read` — Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue...
706- `jira-pp-cli workflows read-previews` — Returns a requested workflow within a given project. The response provides a read-only preview of the workflow,...
707- `jira-pp-cli workflows search` — Returns a [paginated](#pagination) list of global and project workflows. If workflow names are specified in the...
708- `jira-pp-cli workflows update` — Update workflows and related statuses. **[Permissions](#permissions) required:** * *Administer Jira* project...
709- `jira-pp-cli workflows validate-create` — Validate the payload for bulk create workflows. **[Permissions](#permissions) required:** * *Administer Jira*...
710- `jira-pp-cli workflows validate-update` — Validate the payload for bulk update workflows. **[Permissions](#permissions) required:** * *Administer Jira*...
711
712**workflowscheme** — Manage workflowscheme
713
714- `jira-pp-cli workflowscheme assign-scheme-to-project` — Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project....
715- `jira-pp-cli workflowscheme create-workflow-scheme` — Creates a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
716- `jira-pp-cli workflowscheme delete-workflow-scheme` — Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at...
717- `jira-pp-cli workflowscheme get-all-workflow-schemes` — Returns a [paginated](#pagination) list of all workflow schemes, not including draft workflow schemes....
718- `jira-pp-cli workflowscheme get-required-workflow-scheme-mappings` — Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue...
719- `jira-pp-cli workflowscheme get-workflow-scheme` — Returns a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global...
720- `jira-pp-cli workflowscheme get-workflow-scheme-project-associations` — Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a...
721- `jira-pp-cli workflowscheme read-workflow-schemes` — Returns a list of workflow schemes by providing workflow scheme IDs or project IDs. **[Permissions](#permissions)...
722- `jira-pp-cli workflowscheme switch-workflow-scheme-for-project` — Switches a workflow scheme for a project. Workflow schemes can only be assigned to classic projects. **Calculating...
723- `jira-pp-cli workflowscheme update-schemes` — Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any...
724- `jira-pp-cli workflowscheme update-workflow-scheme` — Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project...
725
726**worklog** — Manage worklog
727
728- `jira-pp-cli worklog get-for-ids` — Returns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items....
729- `jira-pp-cli worklog get-ids-of-deleted-since` — Returns a list of IDs and delete timestamps for worklogs deleted after a date and time. This resource is paginated,...
730- `jira-pp-cli worklog get-ids-of-modified-since` — Returns a list of IDs and update timestamps for worklogs updated after a date and time. This resource is paginated,...
731
732
733### Finding the right command
734
735When you know what you want to do but not which command does it, ask the CLI directly:
736
737```bash
738jira-pp-cli which "<capability in your own words>"
739```
740
741`which` resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code `0` means at least one match; exit code `2` means no confident match — fall back to `--help` or use a narrower query.
742
743## Auth Setup
744
745Run `jira-pp-cli auth setup` for the URL and steps to obtain a token (add `--launch` to open the URL). Then store it:
746
747```bash
748jira-pp-cli auth set-token YOUR_TOKEN_HERE
749```
750
751Or set `JIRA_OAUTH2` as an environment variable.
752
753Run `jira-pp-cli doctor` to verify setup.
754
755## Agent Mode
756
757Add `--agent` to any command. Expands to: `--json --compact --no-input --no-color --yes`.
758
759- **Pipeable** — JSON on stdout, errors on stderr
760- **Filterable** — `--select` keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
761
762 ```bash
763 jira-pp-cli attachment get mock-value --agent --select id,name,status
764 ```
765- **Previewable** — `--dry-run` shows the request without sending
766- **Offline-friendly** — sync/search commands can use the local SQLite store when available
767- **Non-interactive** — never prompts, every input is a flag
768- **Explicit retries** — use `--idempotent` only when an already-existing create should count as success, and `--ignore-missing` only when a missing delete target should count as success
769
770### Response envelope
771
772Commands that read from the local store or the API wrap output in a provenance envelope:
773
774```json
775{
776 "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
777 "results": <data>
778}
779```
780
781Parse `.results` for data and `.meta.source` to know whether it's live or local. A human-readable `N results (live)` summary is printed to stderr only when stdout is a terminal — piped/agent consumers get pure JSON on stdout.
782
783## Agent Feedback
784
785When you (or the agent) notice something off about this CLI, record it:
786
787```
788jira-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
789jira-pp-cli feedback --stdin < notes.txt
790jira-pp-cli feedback list --json --limit 10
791```
792
793Entries are stored locally at `~/.jira-pp-cli/feedback.jsonl`. They are never POSTed unless `JIRA_FEEDBACK_ENDPOINT` is set AND either `--send` is passed or `JIRA_FEEDBACK_AUTO_SEND=true`. Default behavior is local-only.
794
795Write what *surprised* you, not a bug report. Short, specific, one line: that is the part that compounds.
796
797## Output Delivery
798
799Every command accepts `--deliver <sink>`. The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:
800
801| Sink | Effect |
802|------|--------|
803| `stdout` | Default; write to stdout only |
804| `file:<path>` | Atomically write output to `<path>` (tmp + rename) |
805| `webhook:<url>` | POST the output body to the URL (`application/json` or `application/x-ndjson` when `--compact`) |
806
807Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.
808
809## Named Profiles
810
811A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.
812
813```
814jira-pp-cli profile save briefing --json
815jira-pp-cli --profile briefing attachment get mock-value
816jira-pp-cli profile list --json
817jira-pp-cli profile show briefing
818jira-pp-cli profile delete briefing --yes
819```
820
821Explicit flags always win over profile values; profile values win over defaults. `agent-context` lists all available profiles under `available_profiles` so introspecting agents discover them at runtime.
822
823## Async Jobs
824
825For endpoints that submit long-running work, the generator detects the submit-then-poll pattern (a `job_id`/`task_id`/`operation_id` field in the response plus a sibling status endpoint) and wires up three extra flags on the submitting command:
826
827| Flag | Purpose |
828|------|---------|
829| `--wait` | Block until the job reaches a terminal status instead of returning the job ID immediately |
830| `--wait-timeout` | Maximum wait duration (default 10m, 0 means no timeout) |
831| `--wait-interval` | Initial poll interval (default 2s; grows with exponential backoff up to 30s) |
832
833Use async submission without `--wait` when you want to fire-and-forget; use `--wait` when you want one command to return the finished artifact.
834
835## Exit Codes
836
837| Code | Meaning |
838|------|---------|
839| 0 | Success |
840| 2 | Usage error (wrong arguments) |
841| 3 | Resource not found |
842| 4 | Authentication required |
843| 5 | API error (upstream issue) |
844| 7 | Rate limited (wait and retry) |
845| 10 | Config error |
846
847## Argument Parsing
848
849Parse `$ARGUMENTS`:
850
8511. **Empty, `help`, or `--help`** → show `jira-pp-cli --help` output
8522. **Starts with `install`** → ends with `mcp` → MCP installation; otherwise → see Prerequisites above
8533. **Anything else** → Direct Use (execute as CLI command with `--agent`)
854
855## MCP Server Installation
856
857Install the MCP binary from this CLI's published public-library entry or pre-built release, then register it:
858
859```bash
860claude mcp add jira-pp-mcp -- jira-pp-mcp
861```
862
863Verify: `claude mcp list`
864
865## Direct Use
866
8671. Check if installed: `which jira-pp-cli`
868 If not found, offer to install (see Prerequisites at the top of this skill).
8692. Match the user query to the best command from the Unique Capabilities and Command Reference above.
8703. Execute with the `--agent` flag:
871 ```bash
872 jira-pp-cli <command> [subcommand] [args] --agent
873 ```
8744. If ambiguous, drill into subcommand help: `jira-pp-cli <command> --help`.