Skip to content

jira adf convert

  • Usage: jira adf convert [flags]

Convert GFM Markdown into a native ADF document without touching Jira, through the exact converter, normalizer, and validator the mutation pipeline runs — a clean conversion here is a clean conversion on submit. Author rich text safely: convert and lint in isolation, then pass the document to --json-input on jira issue create, jira issue edit, jira issue comment add, or jira worklog add.

Strict ADF mode (the mutation default) fails with exit 3 and a source-mapped diagnostic on any lossy conversion step; --adf-best-effort emits the document with the same warning taxonomy mutations use. --output=compact on a clean conversion emits just the document, ready to pipe; a best-effort conversion with warnings folds them into the compact payload, so prefer --output=json there. The command is local-only and needs no profile.

Input

--input <FILE>

Markdown input file; - reads stdin

Accepts a file.

Default: -

Examples

jira adf convert --input notes.md --output=compact | jira issue comment add PROJ-123 --json-input - # (1)!
cat notes.md | jira adf convert --input - --output=json # (2)!
jira adf convert --input notes.md --adf-best-effort --output=json # (3)!
  1. Convert a file and pipe the document straight into a comment
  2. Convert from stdin
  3. Accept documented downgrades (bold+code, images, quotes in list items)