From 8ff14a2a5de9f31c065c6e2deeaaf9c74079a373 Mon Sep 17 00:00:00 2001 From: Hinne Stolzenberg Date: Tue, 24 Mar 2026 05:10:12 +0100 Subject: [PATCH 1/2] docs: add --field textarea multiline and underscore guidance for atl CLI - Document literal \n for multiline textarea fields - Document expand section syntax (+++Title\ncontent\n+++) - Add backtick guidance for code names with underscores - Add --field markdown auto-conversion example --- lib/llm/index.js | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/llm/index.js b/lib/llm/index.js index 6db21f0..7e11d26 100644 --- a/lib/llm/index.js +++ b/lib/llm/index.js @@ -139,6 +139,7 @@ atl issue edit PROJ-1234 --add-label bug --remove-label wontfix atl issue edit PROJ-1234 --priority High atl issue edit PROJ-1234 --field "Story Points=8" # Custom field by name atl issue edit PROJ-1234 --field "customfield_10016=8" # Custom field by ID +atl issue edit PROJ-1234 --field "Custom Field=Some **markdown** text" # Auto-converts to ADF atl issue edit PROJ-1234 --field-file fields.json # Complex values from JSON file # Workflow @@ -335,6 +336,14 @@ Hidden content that can be expanded **Note**: Both descriptions and comments support full Markdown formatting (converted to ADF). Use \`--body-file \` for multi-line or complex content to avoid shell escaping issues. +**Textarea custom fields** (\`--field\`): Automatically converts Markdown to ADF. Use literal \`\\n\` for newlines: +\`\`\`bash +atl issue edit PROJ-1234 --field 'Kontext=Line 1\\n\\nLine 2\\n- Bullet A\\n- Bullet B' +atl issue edit PROJ-1234 --field 'Kontext=+++Expand Title\\nHidden content\\n+++' +\`\`\` + +**Code names with underscores**: Use backticks in descriptions (\`\\\`NegSoft_SN_Item\\\`\`). Bare underscores render as italic (\`NegSoft_SN_Item\` → NegSoft*SN*Item). Backslash-escaping (\`NegSoft\\_SN\\_Item\`) renders backslashes literally. + ### Jira Workflow Transitions Transition names vary by Jira instance and language. Use \`atl issue transition PROJ-123 --list\` to see available transitions for a specific issue. From 5a2ff6f3c0347936b9c0fac4037d29c4a3bbdd75 Mon Sep 17 00:00:00 2001 From: Hinne Stolzenberg Date: Tue, 24 Mar 2026 05:32:06 +0100 Subject: [PATCH 2/2] fix: correct backtick escaping in atl textarea docs --- lib/llm/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/llm/index.js b/lib/llm/index.js index 7e11d26..0cea814 100644 --- a/lib/llm/index.js +++ b/lib/llm/index.js @@ -342,7 +342,7 @@ atl issue edit PROJ-1234 --field 'Kontext=Line 1\\n\\nLine 2\\n- Bullet A\\n- Bu atl issue edit PROJ-1234 --field 'Kontext=+++Expand Title\\nHidden content\\n+++' \`\`\` -**Code names with underscores**: Use backticks in descriptions (\`\\\`NegSoft_SN_Item\\\`\`). Bare underscores render as italic (\`NegSoft_SN_Item\` → NegSoft*SN*Item). Backslash-escaping (\`NegSoft\\_SN\\_Item\`) renders backslashes literally. +**Code names with underscores**: Use backticks in descriptions (\`NegSoft_SN_Item\`). Bare underscores render as italic (\`NegSoft_SN_Item\` → NegSoft*SN*Item). Backslash-escaping (\`NegSoft\\_SN\\_Item\`) renders backslashes literally. ### Jira Workflow Transitions