jira-cli

command module
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 5, 2026 License: MIT Imports: 6 Imported by: 0

README

jira-cli

A command-line interface for Jira Cloud, built in Go.

Quick Start with Claude Code

The fastest way to get everything set up. Open Claude Code and paste:

Follow the full installation guide at https://github.com/dutchview/jira-cli to set up
the jira CLI on my machine. Install Homebrew if I don't have it, install the CLI,
download and install the Claude Code skill from the latest release, and then create
the .env configuration file — ask me for my email and API token. The JIRA base URL
for Dutchview is https://dutchview.atlassian.net

Claude will walk you through the entire setup: installing Homebrew (if needed), the CLI, the skill, and configuring your credentials.

You'll need a JIRA API token. Get one at: https://id.atlassian.com/manage-profile/security/api-tokens

Manual Installation

Homebrew
brew install dutchview/tap/jira
From source
go install github.com/dutchview/jira-cli@latest
Claude Code Skill

This CLI ships with a Claude Code skill for JIRA integration. Download jira-skill.zip, then extract it to your skills folder:

mkdir -p ~/.claude/skills
unzip jira-skill.zip -d ~/.claude/skills/jira
Configuration

Create a .env file at ~/.config/jira/.env:

JIRA_BASE_URL=https://dutchview.atlassian.net
JIRA_EMAIL=you@example.com
JIRA_API_TOKEN=your_api_token

Get your API token at: https://id.atlassian.com/manage-profile/security/api-tokens

Config is loaded from (in order):

  1. Environment variables
  2. .env in current directory
  3. ~/.config/jira/.env
  4. Custom file via --config flag

Run jira configure to see setup help.

Usage

Issues
# Search issues
jira issues search "project = ED ORDER BY updated DESC"
jira issues search -p ED -s "In Progress"
jira issues search --my-issues

# Get issue details
jira issues get ED-123
jira issues get ED-123 --comments
jira issues get ED-123 --json

# Create issue
jira issues create -p ED -t Task -s "Fix the login bug"
jira issues create -p ED -t Bug -s "Crash on save" -d "Steps to reproduce: ..."
jira issues create -p ED -t Task -s "Deadline task" --due-date 2026-03-15

# Update issue
jira issues update ED-123 -s "Updated title"
jira issues update ED-123 -d "New description with **markdown**"
jira issues update ED-123 -a <account-id>
jira issues update ED-123 --unassign
jira issues update ED-123 --due-date 2026-04-01
jira issues update ED-123 --no-due-date

# Delete issue
jira issues delete ED-123
jira issues delete ED-123 --force

# Transition issue
jira issues transition ED-123 "In Progress"
jira issues transition ED-123 "Done"
jira issues transition ED-123 --list
Comments
jira comments list ED-123
jira comments add ED-123 "This is a **markdown** comment"
jira comments add ED-123 --file comment.md
jira comments update ED-123 <comment-id> "Updated text"
jira comments delete ED-123 <comment-id>
Attachments
jira attachments add ED-123 ./screenshot.png
jira attachments add ED-123 ./report.pdf --filename "Q4 Report.pdf"
# List links on an issue
jira links list ED-123
jira links list ED-123 --json

# Link two issues
jira links add ED-123 ED-456 --type "Blocks"
jira links add ED-100 ED-200 --type "Duplicate"

# Delete a link (get ID from 'links list')
jira links delete 12345
jira links delete 12345 --force

# List available link types
jira links types
Projects
jira projects list
jira projects get ED
Users
jira users me
jira users search "john"
jira users assignable -p ED

Markdown-to-ADF

Descriptions and comments support Markdown, which is automatically converted to Atlassian Document Format (ADF). Supported syntax:

  • Bold (**text**)
  • Italic (*text*)
  • Inline code (`code`)
  • Links ([text](url))
  • @mentions (@Display Name — resolved to JIRA users automatically)
  • Headings (# H1 through ###### H6)
  • Bullet lists (- item)
  • Numbered lists (1. item)
  • Code blocks (triple backticks with optional language)
  • Tables (pipe syntax)
  • Horizontal rules (---)
Inline Images

To embed attached images inline in descriptions or comments, first attach the file, then reference it using !filename! syntax:

# 1. Attach the image
jira attachments add ED-123 screenshot.png

# 2. Reference it in description or comment
jira issues update ED-123 --description "## Screenshot\n\n!screenshot.png!"

# With width option
jira issues update ED-123 --description "!screenshot.png|width=720!"

When inline images are detected, the CLI automatically uses JIRA's wiki markup renderer (API v2) which supports embedded attachments.

@Mentions

Use @Display Name in descriptions and comments to mention JIRA users. The CLI resolves display names to JIRA account IDs automatically via user search. Mentions are rendered as proper JIRA mention nodes in the Atlassian Document Format.

# Mention a user in a comment
jira comments add ED-123 "Hey @John Smith, can you review this?"

# Mention in a description
jira issues create -p ED -t Task -s "Review needed" -d "Assigned to @Jane Doe for review"

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
adf
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL