colenio-jira-cli 0.1.2

Modular Jira CLI tool for issue listing, filtering, and management

Jira CLI

Modular, class-based Jira command-line tool for issue listing, searching, and management.

Features

• List issues by project with optional filtering (status, assignee, labels)
• Search with custom JQL queries
• Find issues by text in summary/description
• View issue details with comments
• Assign issues to users
• Transition issues to new status
• Multiple output formats: table, JSON, CSV, Markdown
• dotenv support: Load credentials from .env or local.env in CWD or parent directories

Installation

Via uv (local development)

cd colenio/tools/jira-cli
uv sync
uv run jira-cli list --help

Via uvx (remote/published)

uvx colenio-jira-cli list --project PROJ

Setup

Create a .env or local.env file in your working directory:

# Required
JIRA_URL=https://company.atlassian.net
JIRA_EMAIL=[e-mail]
JIRA_API_TOKEN=your_api_token_here

# Optional
JIRA_PROJECT=PROJ      # Default project for list/find
JIRA_PROJECT_KEY=PROJ  # Backward-compatible fallback

Getting your Jira API Token

1. Log in to your Jira Cloud instance
2. Go to Account Settings → Security
3. Click "Create API Token"
4. Copy the token and save to .env

Usage

List issues

# Basic listing
jira-cli list --project PROJ

# With filters
jira-cli list --project PROJ --status "In Progress" --assignee "[e-mail]"

# With custom JQL
jira-cli list --project PROJ --jql 'priority = High'

# Different output formats
jira-cli list --project PROJ --format json
jira-cli list --project PROJ --format csv > issues.csv
jira-cli list --project PROJ --format md

Search with JQL

jira-cli search 'project = PROJ AND status = "To Do" AND assignee is EMPTY'
jira-cli search 'text ~ "urgent"' --format json

Find by text

jira-cli find --project PROJ "database migration"
jira-cli find --project PROJ "performance issue" --max-results 100

View issue details

jira-cli view PROJ-123
jira-cli view PROJ-456 --comments

Assign issue

jira-cli assign PROJ-789 [e-mail]

Transition issue

jira-cli transition PROJ-999 "In Progress" --comment "Starting work"
jira-cli transition PROJ-999 "Done"

Architecture

• client.py: JiraClient class for REST API calls, auth, and endpoints
• query.py: JiraQuery class for JQL building and search logic
• render.py: JiraRenderer class for output formatting (table, JSON, CSV, Markdown)
• models.py: Pydantic models for Jira structures (JiraIssue, JiraSearchResult, IssueRow)
• dotenv.py: DotEnv class for robust .env/local.env loading
• cli.py: Click CLI commands (list, search, find, view, assign, transition)

All code uses proper classes, no helper functions. Follows informix-migration patterns.

Development

# Install dev dependencies
uv sync --all-groups

# Run tests
uv run pytest

# Format and lint
uv run black jira_cli
uv run ruff check jira_cli

Distribution

This tool is designed for publishing via uvx (like helmrelease-verifier):

1. Push to GitHub at colenio/jira-cli
2. Configure PyPI Trusted Publisher for this repository
3. Tag with version: git tag v0.1.0 and push tag (git push origin v0.1.0)
4. GitHub Action .github/workflows/release.yml builds, tests, and publishes to PyPI
5. Package can be invoked anywhere with: uvx colenio-jira-cli list --project PROJ

PowerShell Integration

Add to $PROFILE (e.g., via dotfiles/aliases.ps1):

function jira-cli {
    uvx colenio-jira-cli @args
}

# Or use directly
alias jira = 'uvx colenio-jira-cli'

Then:

jira list --project PROJ

License

MIT