Acquia CLI requires PHP 8.0 or later, with the PHP-JSON and PHP-PHAR extensions enabled. If you use PHP 7.4, follow the instructions to download earlier releases.
Commands that require a Cloud Platform account prompt you to link your account, if necessary. For more information, see Authenticating with Cloud Platform API.
Note
Acquia CLI is distributed as a standalone Phar archive. Do not install Acquia CLI using Composer, as it might create dependency conflicts.
Open Terminal and type the following commands to automatically install Acquia CLI. Remember to press Enter to execute each command.
Download Acquia CLI:
curl -OL https://github.com/acquia/cli/releases/latest/download/acli.phar
Make the file executable:
chmod +x acli.phar
Rename the file and move it to a location that is globally accessible.
This step allows you to type acli
from anywhere on your system.
Note
If the following command fails, prefix it with sudo
. When
the system prompts for a password, enter your password.
mv acli.phar /usr/local/bin/acli
Run acli
from anywhere on your system to view the installed version of
Acquia CLI and a list of commands.
If you see the Class 'Phar' not found
error, ensure that the
PHP-PHAR extension is enabled.
Acquia CLI warns you if any other runtime requirements are not met. Follow the instructions provided by the error messages.
Note
Acquia CLI does not require the Windows Subsystem for Linux (WSL). It runs natively in any environment that has the required version of PHP and the extensions.
Download the latest acli.phar
file from the releases page and place it in the directory
where you want to run Acquia CLI.
Open Terminal and run php acli.phar
.
You can view the installed version of Acquia CLI and a list of commands. If you encounter an SSL certificate issue, review this known issue.
In CMD and Powershell, Phar files including Acquia CLI must be run using the PHP CLI interpreter in the directory where the Phar is installed. To run Acquia CLI as an executable from another directory, create a batch script. See the following example:
@ECHO OFF
php %~dp0acli.phar %*
Acquia CLI is best installed through a Phar file. The following is an advanced process, so you must use it only when you cannot install Acquia CLI natively or when you create a custom Docker image on top of it.
For more information about Docker, see https://docs.docker.com/.
Note
For all commands that need to invoke the Cloud Platform API, you must prefix them with your API token and secret as environment variables.
Clone the Acquia CLI Git repository and navigate into it:
git clone [email protected]:acquia/cli.git
cd cli
Build the Docker image:
docker build -t acli .
To run Acquia CLI commands, do one of the following:
Create a container that gets destroyed immediately after you run a command:
docker run -e ACLI_KEY=<key> \
-e ACLI_SECRET=<secret> \
-it acli \
php /usr/local/bin/acli -n <command>
Run the commands interactively:
docker run -it acli sh
/ # ACLI_KEY=<key> ACLI_SECRET=<secret> acli -n <command1>
/ # ACLI_KEY=<key> ACLI_SECRET=<secret> acli -n <command2>
After installing Acquia CLI, proceed to Getting started with Acquia CLI.
To enable a larger audience to test new features, Acquia sometimes publishes unstable releases, such as alpha or beta.
Important
Preview releases may contain critical bugs. Use them at your own risk.
To allow Acquia CLI to download unstable releases, run the following command:
$ acli self-update --preview
Downloading Acquia CLI (acquia/cli) 1.30.0-beta1
Download finished
Successfully updated acli
To revert Acquia CLI to download stable releases only, run the following command:
$ acli self-update --stable
Downloading Acquia CLI (acquia/cli) 1.30.0
Download finished
Successfully updated acli
Acquia recommends you to install Acquia CLI 2.x. It is the latest supported version and receives frequent feature updates. Acquia CLI 2.x requires PHP 8. If you use PHP 7, you can install Acquia CLI 1.x, which is minimally supported.
To install Acquia CLI 1.x, follow the earlier steps after replacing the download URL with the latest 1.x release:
curl -OL https://github.com/acquia/cli/releases/download/1.30.1/acli.phar
Note
Acquia does not recommend installing Acquia CLI 1.x.