Using Jira CLI
Use read-only discovery freely. Jira creates, edits, transitions, assignments, comments, worklogs, links, sprint/epic changes, and deletes are external writes and require authorization for the exact operation, target, and content. Supplying values for a draft does not authorize execution.
Establish Context
- Check
command -v jira, jira version, and jira me without exposing token values.
- Identify the Jira instance and config file before querying or mutating. For multiple configs, use the confirmed
JIRA_CONFIG_FILE or -c path consistently.
- If setup is missing, do not run interactive
jira init in an agent shell. Ask the user to complete it or follow a verified non-interactive setup path. Use JIRA_API_TOKEN, .netrc, keychain, or existing secure configuration; never print, persist, or place secrets in command arguments.
- Read installed help for version-sensitive syntax:
jira --help, then jira <resource> <command> --help.
Read Workflow
- Discover project, board, user, status, field, or sprint context before assuming names or IDs.
- Use explicit issue keys for detail views.
- Prefer non-interactive, script-friendly output only when the installed command supports it:
--plain, --raw, --csv, --no-headers, or --columns.
- Avoid commands that open an interactive issue browser; add the supported plain/raw form or use a narrower view.
Read references/commands.md only for the relevant resource's common command shapes, then verify flags against installed help.
Mutation Workflow
- Read the current target and discover valid field/status values.
- Prepare the exact Jira instance/config, issue or container IDs, operation, summary/body/comment/worklog text, transition, assignment, and other changed fields. Do not impose a project-name summary prefix or description template unless the user or repository requires it.
- If the exact operation, target, and content have not already been explicitly authorized for execution, show the complete mutation and ask for approval. Treat requests to draft, explain, review, or prepare Jira content as read-only. Always require exact approval for deletion.
- After approval, use non-interactive flags only when every required parameter is known. Quote values and provide long content through a template or stdin rather than unsafe shell interpolation.
- Re-read the affected issue or resource and report its resulting key, status, assignee, fields, or comment/worklog evidence. A zero exit code alone is not sufficient verification.
Do not broaden one approved mutation into related edits. If Jira returns an unexpected prompt, target, schema, or permission requirement, stop without guessing.
1---2name: use-jira-cli3description: Inspect Jira or prepare and perform precisely authorized Jira mutations with ankitpokhrel/jira-cli (`jira`), including issues, comments, worklogs, epics, sprints, releases, projects, boards, and script-friendly output.4---5
6# Using Jira CLI
7
8Use read-only discovery freely. Jira creates, edits, transitions, assignments, comments, worklogs, links, sprint/epic changes, and deletes are external writes and require authorization for the exact operation, target, and content. Supplying values for a draft does not authorize execution.
9
10## Establish Context
11
121. Check `command -v jira`, `jira version`, and `jira me` without exposing token values.
132. Identify the Jira instance and config file before querying or mutating. For multiple configs, use the confirmed `JIRA_CONFIG_FILE` or `-c` path consistently.
143. If setup is missing, do not run interactive `jira init` in an agent shell. Ask the user to complete it or follow a verified non-interactive setup path. Use `JIRA_API_TOKEN`, `.netrc`, keychain, or existing secure configuration; never print, persist, or place secrets in command arguments.
154. Read installed help for version-sensitive syntax: `jira --help`, then `jira <resource> <command> --help`.
16
17## Read Workflow
18
19- Discover project, board, user, status, field, or sprint context before assuming names or IDs.
20- Use explicit issue keys for detail views.
21- Prefer non-interactive, script-friendly output only when the installed command supports it: `--plain`, `--raw`, `--csv`, `--no-headers`, or `--columns`.
22- Avoid commands that open an interactive issue browser; add the supported plain/raw form or use a narrower view.
23
24Read `references/commands.md` only for the relevant resource's common command shapes, then verify flags against installed help.
25
26## Mutation Workflow
27
281. Read the current target and discover valid field/status values.
292. Prepare the exact Jira instance/config, issue or container IDs, operation, summary/body/comment/worklog text, transition, assignment, and other changed fields. Do not impose a project-name summary prefix or description template unless the user or repository requires it.
303. If the exact operation, target, and content have not already been explicitly authorized for execution, show the complete mutation and ask for approval. Treat requests to draft, explain, review, or prepare Jira content as read-only. Always require exact approval for deletion.
314. After approval, use non-interactive flags only when every required parameter is known. Quote values and provide long content through a template or stdin rather than unsafe shell interpolation.
325. Re-read the affected issue or resource and report its resulting key, status, assignee, fields, or comment/worklog evidence. A zero exit code alone is not sufficient verification.
33
34Do not broaden one approved mutation into related edits. If Jira returns an unexpected prompt, target, schema, or permission requirement, stop without guessing.
narumiruna