Div

id	ProductTOC

Preparation

Docker Images for ACLI
This assumes you have already installed and started Docker on your system. See Docker Documentation for more information on Docker and installation instructions.

...

Action: getSpace

This Confluence action gets detail information about a space.

Table plus

border	0
heading	0
multiple	false
enableHeadingAttributes	false
columnAttributes	style="border:0;width=5%;",style="border:0;width=65%;",style="border:0;width=45%;max-width=50% !important;"
id	steps_table
enableSorting	false
enableHighlighting	false

Include Page

	info:css - pre formatted
	info:css - pre formatted

Action: getClientInfo

This is a basic action available for all clients showing the CLI version and other client OS information.

acli.sh -a getClientInfo Client name: cli, Client version: 9.0.0-SNAPSHOT, Java: OpenJDK 64-Bit Server VM 1.8.0_212, OS: Linux 4.9.125-linuxkit

Action: getProject

This Jira action gets detail information about a project. Since we are not accessing the server with an account with administration access, some information (like for schemes) is not available.

Image RemovedImage Added

Start ACLI Container

In this step, you will install the more recent eap level of the ACLI docker container and be taken directly into the container's shell . It will be ready to run actionswhere you can run CLI commands.

Code Block

language	text
theme	DJango

docker run -ti bobswiftapps/acli:eap /bin/bash

Image Removed

Code Block

language	text
theme	DJango

Tip
bobswift site referenced below in action examples, is a built-in configuration. That means examples can be run right away. Just copy/paste the command entry into the Docker bash shell.

Image Added

Action: getClientInfo

Include Page

	Action Examples - getClientInfo
	Action Examples - getClientInfo

Image Modified

Action: getServerInfo

This action contacts a server and retrieves base information about the server. To start, we contact a pre-configured bobswift Cloud instance using anonymous access.

Code Block

language	text
theme	DJango

acli.sh bobswift -a getServerInfo

Jira version: 1001.0.0-SNAPSHOT, build: 100108, time: 8/27/19 6:17 PM, time zone: , description: Jira for Bob Swift Atlassian Apps, url: https://bobswift.atlassian.net

Code Block

language	text
theme	DJango

acli.sh bobswift -a getServerInfo --outputFormat 2 --outputType table

Server info: 
┌──────────────────────────────┬────────────────────────────────────────┐
│ Product                      │ Jira                                   │
├──────────────────────────────┼────────────────────────────────────────┤
│ Version                      │ 1001.0.0-SNAPSHOT                      │
├──────────────────────────────┼────────────────────────────────────────┤
│ Base URL                     │ https://bobswift.atlassian.net         │
├──────────────────────────────┼────────────────────────────────────────┤
│ Title                        │ Jira for Bob Swift Atlassian Apps      │
├──────────────────────────────┼────────────────────────────────────────┤
│ Build                        │ 100108                                 │
├──────────────────────────────┼────────────────────────────────────────┤
│ Build date                   │ 8/27/19 6:17 PM                        │
├──────────────────────────────┼────────────────────────────────────────┤
│ Current time                 │                                        │
├──────────────────────────────┼────────────────────────────────────────┤
│ License information          │ Not available for this Cloud instance. │
├──────────────────────────────┼────────────────────────────────────────┤
│ Client                       │ jira                                   │
├──────────────────────────────┼────────────────────────────────────────┤
│ User                         │ anonymous                              │
├──────────────────────────────┼────────────────────────────────────────┤
│ Response time (milliseconds) │ 1147                                   │
└──────────────────────────────┴────────────────────────────────────────┘

Image Removed

Action: getProjectList

This Jira action gets a list of projects that belong to the CLI category.

Include Page

	Action Examples - Jira getServerInfo
	Action Examples - Jira getServerInfo

Tip
For Linux and Mac, to maximize the display of tables for the full terminal width, run: export COLUMNS=$COLUMNS

Code Block

language	text
theme	DJango

acli.sh bobswift -a getProjectList --category CLI --outputType table

23 projects in list
┌──────────┬───────┬────────────────────────┬────────────────────────┬─────────────────────────┬──────────────────┬──────────────┬─────────────────────────┬────────────────────────┐
│ Key      │ Id    │ Name                   │ Description            │ Lead                    │ Default Assignee │ Project Type │ Project URL             │ Jira URL               │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ ACLI     │ 10212 │ Atlassian Command Line │ Consolidated           │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │ distribution           │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/AC │ sian.net/browse/ACLI   │
│          │       │                        │ containing all CLI     │                         │                  │              │ LI                      │                        │
│          │       │                        │ clients                │                         │                  │              │                         │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ AGILECLI │ 13200 │ Agile Command Line     │                        │ SriniP [Bob Swift       │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/AG │ sian.net/browse/AGILEC │
│          │       │                        │                        │                         │                  │              │ ILECLI                  │ LI                     │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ BCCLI    │ 13100 │ Bitbucket Cloud        │                        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Command Line Interface │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/BC │ sian.net/browse/BCCLI  │
│          │       │ (CLI)                  │                        │                         │                  │              │ CLI                     │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ BCLI     │ 10122 │ Bamboo Command Line    │ Bamboo CLI client      │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/BC │ sian.net/browse/BCLI   │
│          │       │                        │                        │                         │                  │              │ LI                      │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ BCLIP    │ 10600 │ Run CLI Actions in     │ Bamboo tasks for ACLI  │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Bamboo                 │ functions              │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/BC │ sian.net/browse/BCLIP  │
│          │       │                        │                        │                         │                  │              │ LIP                     │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ CCLI     │ 10223 │ Run CLI Actions in     │ Confluence macros for  │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Confluence             │ ACLI functions         │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/CC │ sian.net/browse/CCLI   │
│          │       │                        │                        │                         │                  │              │ LI                      │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ CRUCLI   │ 10121 │ Crucible Command Line  │ Crucible CLI client    │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/CR │ sian.net/browse/CRUCLI │
│          │       │                        │                        │                         │                  │              │ UCLI                    │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ CSOAP    │ 10214 │ Confluence Command     │ Confluence CLI client  │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Line Interface (CLI)   │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/CS │ sian.net/browse/CSOAP  │
│          │       │                        │                        │                         │                  │              │ OAP                     │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ CSOAPLIB │ 10127 │ Confluence SOAP        │ SOAP library for       │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Library                │ accessing Confluence   │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/CS │ sian.net/browse/CSOAPL │
│          │       │                        │                        │                         │                  │              │ OAPLIB                  │ IB                     │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ CSVCLI   │ 12800 │ CSV CLI                │                        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │                        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/cs │ sian.net/browse/CSVCLI │
│          │       │                        │                        │                         │                  │              │ vcli                    │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ DW       │ 12900 │ Data Warehouse for     │                        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ DevOps                 │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/DW │ sian.net/browse/DW     │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ FCLI     │ 10112 │ Fisheye Command Line   │ FishEye CLI client     │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/FC │ sian.net/browse/FCLI   │
│          │       │                        │                        │                         │                  │              │ LI                      │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ HCLI     │ 12000 │ HipChat Command Line   │ HipChat CLI client     │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/HC │ sian.net/browse/HCLI   │
│          │       │                        │                        │                         │                  │              │ LI                      │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ JCLI     │ 10117 │ Jira Command Line      │ Jira CLI client and    │ SriniP [Bob Swift       │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │ connector              │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/JC │ sian.net/browse/JCLI   │
│          │       │                        │                        │                         │                  │              │ LI                      │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ JCLIP    │ 10500 │ Run CLI Actions in     │ JIRA workflow          │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ JIRA                   │ functions for ACLI     │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/JC │ sian.net/browse/JCLIP  │
│          │       │                        │ functions              │                         │                  │              │ LIP                     │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ JSDCLI   │ 12201 │ Service Desk Command   │ JIRA Service Desk CLI  │ Bob Swift               │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Line Interface (CLI)   │ client                 │                         │                  │              │ ian.net/wiki/display/JS │ sian.net/browse/JSDCLI │
│          │       │                        │                        │                         │                  │              │ DCLI                    │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ SCLI     │ 10800 │ Bitbucket Command Line │ Bitbucket (Stash) CLI  │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │ client                 │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/SC │ sian.net/browse/SCLI   │
│          │       │                        │                        │                         │                  │              │ LI                      │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ SCLIP    │ 10900 │ Run CLI Actions in     │ Stash hooks for ACLI   │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Bitbucket              │ functions              │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/SC │ sian.net/browse/SCLIP  │
│          │       │                        │                        │                         │                  │              │ LIP                     │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ SLACKCLI │ 13203 │ CLI for Slack          │ Not created by,        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │                        │ affiliated with, or    │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/SL │ sian.net/browse/SLACKC │
│          │       │                        │ supported by Slack     │                         │                  │              │ ACKCLI                  │ LI                     │
│          │       │                        │ Technologies, Inc.     │                         │                  │              │                         │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ STRCLI   │ 13002 │ Structure Command Line │                        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/ST │ sian.net/browse/STRCLI │
│          │       │                        │                        │                         │                  │              │ RCLI                    │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ TCLI     │ 13001 │ Trello Command Line    │                        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/TC │ sian.net/browse/TCLI   │
│          │       │                        │                        │                         │                  │              │ LI                      │                        │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ TEMPOCLI │ 13000 │ Tempo Command Line     │                        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/TE │ sian.net/browse/TEMPOC │
│          │       │                        │                        │                         │                  │              │ MPOCLI                  │ LI                     │
├──────────┼───────┼────────────────────────┼────────────────────────┼─────────────────────────┼──────────────────┼──────────────┼─────────────────────────┼────────────────────────┤
│ UPMCLI   │ 12700 │ UPM Command Line       │                        │ Bob Swift [Bob Swift    │                  │ software     │ https://bobswift.atlass │ https://bobswift.atlas │
│          │       │ Interface (CLI)        │                        │ Atlassian Apps]         │                  │              │ ian.net/wiki/display/UP │ sian.net/browse/UPMCLI │
│          │       │                        │                        │                         │                  │              │ MCLI                    │                        │
└──────────┴───────┴────────────────────────┴────────────────────────┴─────────────────────────┴──────────────────┴──────────────┴─────────────────────────┴────────────────────────┘

Image Removed

Code Block

language	text
theme	DJango

acli.sh bobswift -a getProject --project ACLI --outputType table

Data for project: ACLI
┌──────────────────┬──────────────────────────────────────────────────────┐
│ Key              │ ACLI                                                 │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Id               │ 10212                                                │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Name             │ Atlassian Command Line Interface (CLI)               │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Description      │ Consolidated distribution containing all CLI clients │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Lead             │ Bob Swift [Bob Swift Atlassian Apps]                 │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Default assignee │ PROJECT_LEAD                                         │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Project type     │ software                                             │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Project style    │ classic                                              │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Project URL      │ https://bobswift.atlassian.net/wiki/display/ACLI     │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Jira URL         │ https://bobswift.atlassian.net/browse/ACLI           │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Category         │ CLI                                                  │
├──────────────────┼──────────────────────────────────────────────────────┤
│ Issue count      │ 395                                                  │
└──────────────────┴──────────────────────────────────────────────────────┘

Image Removed

Code Block

language	text
theme	DJango

acli.sh bobswift -a getSpace --space ACLI --outputType table

Data for space: ACLI
┌─────────────────┬─────────────────────────────────────────────────┐
│ Space key       │ ACLI                                            │
├─────────────────┼─────────────────────────────────────────────────┤
│ Id              │ 2031617                                         │
├─────────────────┼─────────────────────────────────────────────────┤
│ Name            │ Atlassian Command Line Interface (CLI)          │
├─────────────────┼─────────────────────────────────────────────────┤
│ Description     │                                                 │
├─────────────────┼─────────────────────────────────────────────────┤
│ Home page title │ Atlassian Command Line Interface (CLI)          │
├─────────────────┼─────────────────────────────────────────────────┤
│ Home page id    │ 1966101                                         │
├─────────────────┼─────────────────────────────────────────────────┤
│ Type            │ global                                          │
├─────────────────┼─────────────────────────────────────────────────┤
│ Categories      │ cli                                             │
├─────────────────┼─────────────────────────────────────────────────┤
│ URL             │ https://bobswift.atlassian.net/wiki/spaces/ACLI │
└─────────────────┴─────────────────────────────────────────────────┘

Image Removed

Action: getServerInfo

This Confluence action gets a list of pages in a space and outputs the list as a CSV file.

Code Block

language	text
theme	DJango

acli.sh bobswift -a getPageList --space ACLI --file spaceList.csv 316 pages in list written to file: spaceList.csv

Include Page

	Action Examples - Jira getServerInfo with output format 2
	Action Examples - Jira getServerInfo with output format 2

Image Added

Action: getProjectList

Include Page

	Action Examples - Jira getProjectList help
	Action Examples - Jira getProjectList help

Include Page

	Action Examples - Jira getProjectList
	Action Examples - Jira getProjectList

Image Added

Action: getProject

Include Page

	Action Examples - Jira getProject
	Action Examples - Jira getProject

Image Added

Action: getSpace

Include Page

	Action Examples - Confluence getSpace
	Action Examples - Confluence getSpace

Image Added

Action: getPageList

Include Page

	Action Examples - Confluence getPageList
	Action Examples - Confluence getPageList

Versions Compared

Old Version 5

New Version Current

Key

On this page

Preparation

Action: getSpace

Action: getClientInfo

Action: getProject

Start ACLI Container

Action: getClientInfo

Action: getServerInfo

Action: getProjectList

Action: getServerInfo

Action: getProjectList

Action: getProject

Action: getSpace

Action: getPageList

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

On this page

Preparation

Start ACLI Container

Action: getClientInfo

Action: getClientInfo

Action: getServerInfo

Action: getProjectList

Action: getProject

Action: getSpace

Action: getServerInfo

Action: getProjectList

Action: getProject

Action: getSpace

Action: getPageList