Skip to content

docs: add --field textarea multiline and underscore guidance #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hinne1 merged 2 commits into from
Mar 24, 2026
Merged

docs: add --field textarea multiline and underscore guidance #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ff14a2
docs: add --field textarea multiline and underscore guidance for atl CLI
Hinne1 Mar 24, 2026
5a2ff6f
fix: correct backtick escaping in atl textarea docs
Hinne1 Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions lib/llm/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <path>\` 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.
Expand Down
Loading