/
CLI Client installation and use - Version 12.x

CLI Client installation and use - Version 12.x

Preparation

  • If you are using a platform independent distribution, this assumes you have already have Java 11 or Java 17 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

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

Windows
cd c:\tools\acli-12.0.0 acli -a getClientInfo Client name: cli, Client version: 12.0.0, Client build: 2024-12-03T19:59:31, Java: OpenJDK 64-Bit Server VM 17.0.6, OS: Windows
Linux, OSX
cd /tools/acli-12.0.0 ./acli.sh -a getClientInfo Client name: cli, Client version: 12.0.0, Client build: 2024-12-03T19:59:31, Java: OpenJDK 64-Bit Server VM 17.0.6, OS: Mac OS X 12.6.6

Best Practices

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

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

General 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.

Action: getProjectList

 

Action: getProject

Action: getSpace

Action: getPageList