acli

Overview

Utilize Atlassian Command Line Interface (CLI) to effortlessly engage with our suite of products through a streamlined command-line interface. Atlassian CLI provides a powerful toolset that allows users to automate tasks, integrate processes, and interact with various Atlassian products such as Jira, all from the comfort of your terminal.

Options

acli --help

Getting Started

Check to see if acli is installed:

acli --version

It not installed, install it:

brew tap atlassian/homebrew-acli
brew install acli

It installed, verify it:

acli --version

Authenticating to Jira

To connect to your Atlassian account, you need to authenticate.

Check if you are already authenticated:

acli jira auth status

If you are not authenticated, authenticate:

acli jira auth login --web

acli Jira Commands

Create a work item

acli jira workitem create

# Create work item by supplying a summary, project name and work item type
acli jira workitem create --summary "New Task" --project "TEAM" --type "Task"

# Create work item from file and supplying all work item details
acli jira workitem create --from-file "workitem.txt" --project "PROJ" --type "Bug" --assignee "user@atlassian.com" --label "bug,cli"

# Generate a JSON file that could be used for workitem creation via --from-json flag
acli jira workitem create --generate-json

# Create work item from a JSON file
acli jira workitem create --from-json "workitem.json"

View a work item

acli jira workitem view

Edit a work item

acli jira workitem edit

acli jira workitem edit

# Edit work item with work item keys
acli jira workitem edit --key "KEY-1,KEY-2" --summary "New Summary"

# Edit work item with JQL query
acli jira workitem edit --jql "project = TEAM" --assignee "user@atlassian.com"

# Edit work item with Filter ID
acli jira workitem edit --filter 10001 --description "Updated description" --yes

# Generate a JSON file that could be used for workitem edit via --from-json flag
acli jira workitem edit --generate-json

# Edit work item from a JSON file
acli jira workitem edit --from-json "workitem.json"

Transition a work item

acli jira workitem transition

acli jira workitem transition

# Transition work item with work item keys
acli jira workitem transition --key "KEY-1,KEY-2" --status "Done"

# Transition work item with JQL query
acli jira workitem transition --jql "project = TEAM" --status "In Progress"

# Transition work item with filter ID
acli jira workitem transition --filter 10001 --status "To Do" --yes