Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Div
idProductTOC

On this page

Table of Contents
maxLevel1
excludeOn this page
typeflat
separator |

Include Page
ACLI:CLI Client Installation and Use - Version 11.x - HeaderACLI:
CLI Client Installation and Use - Version 11.x - Header

...

  • If you are using a platform independent distribution, this assumes you have already have Java 8 or Java 11 installed on your system. Reference: Oracle or Adopt Open Java (recommended). Verify by running the following from your command line: java -version
  • Platform specific distributions have no need for a separate Java

...

Div

Include Page
info:css - pre formatted
info:css - pre formatted

Download Distribution

Unzip

  • Use your favorite unzip tool on the distribution file
  • Put the resulting directory in a convenient location of your choosing
  • For our example, we use tools

Verify Installation

Code Block
languagetext
titleWindows
cd c:\tools\atlassianacli-cli-1011.30.0
acli -a getClientInfo

Client name: cli, Client version: 1011.30.0, Client build: 20222023-0106-20T1908T19:59:31, Java: OpenJDK 64-Bit Server VM 1117.0.116, OS: Windows


Code Block
languagetext
titleLinux, OSX
cd /tools/atlassianacli-cli-1011.30.0
./acli.sh -a getClientInfo

Client name: cli, Client version: 1011.30.0, Client build: 20222023-0106-20T1908T19:59:31, Java: OpenJDK 64-Bit Server VM 1117.0.116, OS: Mac OS X 1112.6.56


Best Practices

Tip
titleGeneral
  • Best to use a larger command window at least 100 columns wide, the larger the better for output viewing
  • Best to add your installation directory to your system path so you can run acli actions more easily on a regular basis
  • Recommend using the configuration support and other option customization capabilities to make day to day use simple
    • Some examples of this follow later and there are more detailed pages as well


Tip
titleLinux and OSX
  • To make the most of screen width for table output, it is recommended to add the following to your bash profile: export COLUMNS=$COLUMNS
  • Recommend defining acli (on your path) as a link to acli.sh or as a customized bash script similar to acli.sh
    • Examples here and on other documentation use this shortcut for simplification



...

Div

Include Page
info:css - pre formatted
info:css - pre formatted

General Help

Include Page
ACLI:Action Examples - acli helpACLI:
Action Examples - acli help

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.

Include Page
ACLI:Action Examples - Jira getServerInfoACLI:
Action Examples - Jira getServerInfo


Include Page
ACLI:Action Examples - Jira getServerInfo with output format 2ACLI:
Action Examples - Jira getServerInfo with output format 2

Action: getProjectList

Include Page
ACLI:Action Examples - Jira getProjectList helpACLI:
Action Examples - Jira getProjectList help


Include Page
ACLI:Action Examples - Jira getProjectListACLI:
Action Examples - Jira getProjectList


Action: getProject

Include Page
ACLI:Action Examples - Jira getProjectACLI:
Action Examples - Jira getProject

Action: getSpace

Include Page
ACLI:Action Examples - Confluence getSpaceACLI:
Action Examples - Confluence getSpace

Action: getPageList

Include Page
ACLI:Action Examples - Confluence getPageListACLI:
Action Examples - Confluence getPageList


...