Installing the Acquia Pipelines client

This page describes how to download and install the Acquia Pipelines client, as well as how to update a previously installed client. The client is installed locally to perform Pipelines jobs, which are carried out by the Acquia Pipelines service in the cloud.

Requirements

To use the Acquia Pipelines command line application, you must have PHP 5.6 or PHP 7.0 available in your local work environment.

Permission

To use Acquia Pipelines, you must have the Execute pipelines permission for the Acquia Cloud application that you're working with. By default, users who have been assigned the Team lead or Senior Developer role have this permission, while users with the Developer role do not. An organization's Administrator can create new roles that have these permissions, or modify existing roles to add these permissions. For more information, see Setting the Execute pipelines permission using the Acquia Cloud interface. See also Working with roles and permissions for more general information about permissions in Acquia Cloud.

Installing with Acquia Dev Desktop

The Acquia Pipelines client is included with Acquia Dev Desktop (2016-07-28 release or later), which is Acquia's free application that allows you to run and develop Drupal websites locally on your computer. Download Acquia Dev Desktop for Mac OS from the Acquia downloads page, then open and run the installer. For full installation instructions, see Installing Acquia Dev Desktop.

After you install Acquia Dev Desktop, close and then reopen your command prompt window or shell sessions to ensure that the Acquia Pipelines client directory (/Applications/DevDesktop/tools) is in your PATH.

Installing from the command line

You can also install the Acquia Pipelines client from the command line by using the following commands:

curl -o pipelines https://cloud.acquia.com/pipeline-client/download
chmod a+x pipelines

Move the pipelines program to a directory in your PATH. If you are not familiar with how to make the Acquia Pipelines client executable in your PATH, we recommend using the Acquia Dev Desktop installer.

Configuring the client (authentication)

After you have installed the Acquia Pipelines client, you must configure the client with an Acquia Cloud API token. This enables the client to authenticate with the Acquia Pipelines service. You can get the Acquia Cloud API token from the Acquia Cloud interface by completing the following steps:

  1. Sign in to the Acquia Cloud interface.
  2. Click the avatar in the upper right to open your profile, and then click API tokens. Or, go directly to cloud.acquia.com/app/profile/tokens.
  3. Click the plus button to add an API token.
  4. In the Create API Token dialog box, enter a label for the token, such as Pipelines. A token label can help you identify your tokens if you create more than one.
  5. Click Create Token. The Create API Token dialog displays the API key and the API secret that make up the token. You can view the API key at any time in the Acquia Cloud interface.
  6. In a separate command prompt window, run the following command:

    pipelines configure
  7. Copy and paste the API key and API secret you previously obtained in this procedure to the pipelines configure command prompts.

You can now use Acquia Pipelines with your codebase. Your credentials are stored at ~/.acquia/pipelines/credentials.

Updating the Acquia Pipelines client

If you have already installed the Acquia Pipelines client, you can run one of the following commands to update your client, depending on your needs:

Command Description
pipelines --version Displays your current version number
pipelines self-update Updates your client to the latest available version
pipelines self-update --force Updates your client to the latest available version — skips the version check
pipelines self-update --rollback Reverts the client to the immediately previous version of the client

Add new comment

Plain text

  • No HTML tags allowed.
  • Lines and paragraphs break automatically.
  • Web page addresses and email addresses turn into links automatically.
By submitting this form, you accept the Mollom privacy policy.

Contact supportStill need assistance? Contact Acquia Support