Skip to content

Commit feea54e

Browse files
authored
docs: add --field textarea multiline and underscore guidance (#61)
* 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 * fix: correct backtick escaping in atl textarea docs
1 parent c40575c commit feea54e

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

lib/llm/index.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ atl issue edit PROJ-1234 --add-label bug --remove-label wontfix
139139
atl issue edit PROJ-1234 --priority High
140140
atl issue edit PROJ-1234 --field "Story Points=8" # Custom field by name
141141
atl issue edit PROJ-1234 --field "customfield_10016=8" # Custom field by ID
142+
atl issue edit PROJ-1234 --field "Custom Field=Some **markdown** text" # Auto-converts to ADF
142143
atl issue edit PROJ-1234 --field-file fields.json # Complex values from JSON file
143144
144145
# Workflow
@@ -335,6 +336,14 @@ Hidden content that can be expanded
335336
336337
**Note**: Both descriptions and comments support full Markdown formatting (converted to ADF). Use \`--body-file <path>\` for multi-line or complex content to avoid shell escaping issues.
337338
339+
**Textarea custom fields** (\`--field\`): Automatically converts Markdown to ADF. Use literal \`\\n\` for newlines:
340+
\`\`\`bash
341+
atl issue edit PROJ-1234 --field 'Kontext=Line 1\\n\\nLine 2\\n- Bullet A\\n- Bullet B'
342+
atl issue edit PROJ-1234 --field 'Kontext=+++Expand Title\\nHidden content\\n+++'
343+
\`\`\`
344+
345+
**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.
346+
338347
### Jira Workflow Transitions
339348
340349
Transition names vary by Jira instance and language. Use \`atl issue transition PROJ-123 --list\` to see available transitions for a specific issue.

0 commit comments

Comments
 (0)