Skip to content

jira issue link

  • Usage: jira issue link KEY... [flags]

Create, list, delete, and discover Jira issue links. Use the default action jira issue link KEY --to OTHER --type NAME to create a link, or use the subcommands for reads and deletes.

For create, KEY is the inward issue and --to is the outward issue. Link type semantics come from Jira, so confirm the configured type names with jira issue link types when direction matters. The create output's preview sentences show the line each issue's page will render — the inward issue displays the type's outward phrase, not its inward one — so check them before trusting the direction.

--json-input accepts the native POST /rest/api/3/issueLink body — type, inwardIssue, outwardIssue, and an optional comment — so an API-shaped payload needs no translation to flags.

--dry-run previews create requests without contacting Jira. Link deletes are force-gated in headless, agent, and --no-input mode.

Input

--json-input <FILE>

Read the native issueLink create body from a JSON file (type, inwardIssue, outwardIssue, comment)

Accepts a file.

--to <KEY>

Outward issue key

--type <NAME>

Link type name (Blocks, Relates, Cloners, …)

Safety

--dry-run

Preview without creating the link

Execution

-p --parallelism <N>

Maximum concurrent requests (1-16)

Default: 1

Output fields

With --output json, the response envelope's data object carries these fields. Run jira agent schema for the full machine-readable schema.

Field Type Description
comment object
dry_run boolean
inward_issue.id string
inward_issue.key string
inward_issue.self string
outward_issue.id string
outward_issue.key string
outward_issue.self string
preview.inward_issue_sentence string
preview.outward_issue_sentence string
type string
type_id string

Examples

jira issue link PROJ-123 --to PROJ-456 --type Blocks # (1)!
jira issue link PROJ-123 --to PROJ-456 --type Relates # (2)!
jira issue link --json-input link.json # (3)!
jira issue link PROJ-123 --to PROJ-456 --type Blocks --dry-run # (4)!
  1. Mark one issue as blocking another
  2. Run 'jira issue link types' for the link types your site allows
  3. Create a link from a native Jira REST body
  4. Preview a link creation without contacting Jira

Subcommands