---
title: "CLI Client installation and use - Version 12.x"
canonical: "https://support.appfire.com/space/ACLI/1529675809/CLI%20Client%20installation%20and%20use%20-%20Version%2012.x"
format: markdown
---
> Macro (aura-html)

> Macro (include)

# 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](https://www.oracle.com/java/technologies/downloads/)<span style="color: #333333"> or </span><span style="color: #333333">[Adopt Open Java](https://adoptopenjdk.net/)</span><span style="color: #333333"> (recommended).</span> Verify by running<span style="color: #333333"> the following from your command line: </span>**java -version**
- Platform specific distributions have no need for a separate Java

# Steps

|  |  |
| --- | --- |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | # Download Distribution<br>- A single client distribution contains all CLI clients
- From [Downloads - Version 12.x](https://appfire.atlassian.net/wiki/spaces/ACLI/pages/1530003464) or [Downloads - Early Access Program (EAP)](https://appfire.atlassian.net/wiki/spaces/ACLI/pages/60555765)
- Download to any location you prefer for downloads |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | # Unzip<br>- 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](media://54b716ce-dd5e-4560-8262-1747416d456f) | # Verify Installation<br>- Open a [command prompt window](http://windows.microsoft.com/en-us/windows-vista/open-a-command-prompt-window) (Windows) or a [terminal window](http://www.dummies.com/how-to/content/how-to-use-the-terminal-in-os-x-yosemite.html) (Linux, OSX)
- **cd** to the installation directory<br>##### **Windows**<br>```plaintext
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
```<br>##### **Linux, OSX**<br>```plaintext
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
``` |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | # Best Practices<br>> ✅ ### 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<br>> ✅ ### 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](media://54b716ce-dd5e-4560-8262-1747416d456f) | ## General Help<br>> Macro (include) |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | ## Action: getServerInfo<br>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.<br>> Macro (include)<br>> Macro (include) |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | ## Action: getProjectList<br>> Macro (include)<br>> Macro (include) |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | ## Action: getProject<br>> Macro (include) |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | ## Action: getSpace<br>> Macro (include) |
| ![image](media://54b716ce-dd5e-4560-8262-1747416d456f) | ## Action: getPageList<br>> Macro (include) |