Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

idProductTOC

On this page

...

Include Page

...

CLI Client Installation and Use - Version 11.x - Header

...

CLI Client Installation and Use - Version 11.x - Header

Preparation

  • 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

Steps

...

Image Removed

...

Image Added

Download distribution

...

...

Image Added

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

...

Image Added

Verify

...

installation

  • Open

...

...

Windows
Code Block
languagetext

...

cd c:\tools\

...

acli-

...

11.

...

0.0
acli -a getClientInfo

Client name: cli, Client version: 

...

11.

...

0.0, Client build: 

...

2023-

...

06-

...

08T19:59:31, Java: OpenJDK 64-Bit Server VM 

...

17.0.

...

6, OS: Windows
Linux, OSX
Code Block
languagetext

...

cd /tools/

...

acli-

...

11.

...

0.0
./acli.sh -a getClientInfo

Client name: cli, Client version: 

...

11.

...

0.0, Client build: 

...

2023-

...

06-

...

08T19:59:31, Java: OpenJDK 64-Bit Server VM 

...

17.0.

...

6, OS: Mac OS X 

...

12.6.

...

6

...

Image Added

Best

...

practices

...

Info

General

  • 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

...

Info

...

Linux 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

Examples

  • No configuration or licenses are required for these examples

...

Image Added

General Help

Include Page

...

Action

...

examples - acli help

...

Action

...

examples - acli help

...

Image Added

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

...

Action Examples - Jira getServerInfo

...

Action Examples - Jira getServerInfo
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:

...

getPageist

Include Page

...

Action Examples - Confluence getPageList

...

Action Examples - Confluence getPageList