Skip to content

chbosse/JiraCLI

Repository files navigation

JIRA-CLI

Command-line interface for JIRA operations using Atlassian CLI (acli)


Version: 1.0.0 | Last Updated: 2026-01-27

Overview

This project uses the Atlassian CLI (acli) to interact with JIRA from the command line. The CLI provides a powerful interface for managing work items, projects, sprints, and more.

Installation

Installing Atlassian CLI (acli)

macOS Installation

  1. Download the acli binary:

    curl -LO "https://acli.atlassian.com/darwin/latest/acli_darwin_arm64/acli"
  2. Make it executable:

    chmod +x acli
  3. Move to PATH location:

    mkdir -p ~/.local/bin
    mv acli ~/.local/bin/
  4. Verify installation:

    acli --version

    Expected output: acli version 1.3.12-stable (or later)

Authentication Setup

Step 1: Initial Authentication

acli auth login

This will:

  • Prompt you to select your Atlassian site (e.g., https://idmeinc.atlassian.net)
  • Open a browser for OAuth authentication
  • Complete the authentication flow

Step 2: Jira-Specific Authentication

acli jira auth login

Choose your authentication method:

  • API Token (recommended)
  • Web (OAuth)

Step 3: Verify Authentication

acli auth status

Expected output:

✓ Authenticated
  Site: idmeinc.atlassian.net
  Email: [email protected]
  Authentication Type: oauth

You can now use the following apps with acli: Jira

Available Commands

Project Commands

# List recent projects
acli jira project list --recent

# List all projects with pagination
acli jira project list --paginate

# List limited number of projects
acli jira project list --limit 5

Work Item Commands

Search & View

# Search for work items assigned to you
acli jira workitem search --assignee currentUser()

# View a specific issue
acli jira workitem view INTAKE-123

# Search with JQL
acli jira workitem search --jql "project = INTAKE AND status = 'In Progress'"

Create & Edit

# Create a new work item
acli jira workitem create --project INTAKE

# Edit a work item
acli jira workitem edit INTAKE-123

# Bulk create work items
acli jira workitem create-bulk

Assign & Transition

# Assign work item
acli jira workitem assign INTAKE-123 --assignee "[email protected]"

# Transition work item status
acli jira workitem transition INTAKE-123

# Clone a work item
acli jira workitem clone INTAKE-123

Comments & Attachments

# Add comment to work item
acli jira workitem comment add INTAKE-123

# View comments
acli jira workitem comment list INTAKE-123

# Add attachment
acli jira workitem attachment add INTAKE-123 --file document.pdf

# List attachments
acli jira workitem attachment list INTAKE-123

Archive & Delete

# Archive work item
acli jira workitem archive INTAKE-123

# Unarchive work item
acli jira workitem unarchive INTAKE-123

# Delete work item
acli jira workitem delete INTAKE-123

Board Commands

# View board commands
acli jira board --help

Sprint Commands

# View sprint commands
acli jira sprint --help

Dashboard Commands

# View dashboard commands
acli jira dashboard --help

Field Commands

# View field commands
acli jira field --help

Filter Commands

# View filter commands
acli jira filter --help

Common Workflows

Daily Standup - Check Your Tasks

# View all your assigned work items
acli jira workitem search --assignee currentUser() --status "In Progress,To Do"

Creating a New Task

# Interactive creation
acli jira workitem create --project INTAKE

# Follow the prompts to enter:
# - Issue type (Story, Task, Bug, etc.)
# - Summary
# - Description
# - Priority
# - Labels

Updating Task Status

# Transition a task to different status
acli jira workitem transition INTAKE-123

# Select from available transitions:
# - To Do → In Progress
# - In Progress → Done
# - etc.

Configuration

View Current Configuration

acli config --help

Global Configuration Location

~/.config/acli/

Troubleshooting

Authentication Issues

If you encounter authentication errors:

# Re-authenticate
acli auth login
acli jira auth login

# Check status
acli auth status

Clear Credentials

# Logout from specific site
acli auth logout

# Logout from all sites
acli auth logout --all

Tech Stack

  • Atlassian CLI (acli) v1.3.12-stable
  • Platform: macOS (Darwin 24.6.0)
  • Node.js: v25.0.0 (for future scripting/automation)

Additional Resources

Deployment

This CLI tool runs locally and does not require deployment. Authentication credentials are stored securely in ~/.config/acli/.

Project Structure

JIRA-CLI/
├── README.md          # This file - complete setup and usage guide
├── CLAUDE.md          # AI-assisted development workflow guidelines
├── acli              # Atlassian CLI binary (installed to ~/.local/bin/)
└── docs/             # Additional documentation (future)
    ├── workflows/    # Custom workflow examples
    └── scripts/      # Automation scripts (future)

Working with AI-Assisted Development

This project follows AI-assisted development workflows. See CLAUDE.md for detailed guidelines.

Workflow Summary

  1. Plan First - Think through problems and create a plan in todo.md
  2. Create Checklist - Break down tasks into actionable items
  3. Execute Incrementally - Complete tasks one by one
  4. Explain Changes - Document what changed at each step
  5. Keep Changes Minimal - Avoid big rewrites
  6. Security Review - Check for vulnerabilities
  7. Document Summary - Add review section when complete

Next Steps

Immediate Next Steps

  • Test all acli commands with your actual JIRA projects
  • Create custom workflow scripts for common tasks
  • Set up shell aliases for frequently used commands
  • Document team-specific workflows

Future Enhancements

  • Create wrapper scripts for common operations
  • Build automation for daily standup reports
  • Integrate with CI/CD pipelines
  • Create templates for common issue types
  • Add bulk operations for team management

Shell Aliases (Optional)

Add these to your ~/.bashrc or ~/.zshrc for quick access:

# JIRA CLI shortcuts
alias jira='acli jira'
alias jira-mine='acli jira workitem search --assignee currentUser()'
alias jira-view='acli jira workitem view'
alias jira-create='acli jira workitem create'
alias jira-projects='acli jira project list --recent'

Support & Feedback

Getting Help

# General help
acli --help

# Command-specific help
acli jira --help
acli jira workitem --help
acli jira workitem create --help

Submit Feedback

acli feedback

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors