Information for: DEVELOPERS   PARTNERS

Installing the pipelines client

Acquia Cloud pipelines client

This page describes how to download and install the pipelines client, and how to update a previously installed client. The client is installed locally to perform pipelines jobs, which are carried out by Acquia Cloud.

Note

Installing the pipelines command-line client is optional, and not required for pipelines to function with your application.

Requirements

To use the pipelines client, you must have PHP 7.1 available in your local work environment.

Permission

To use the pipelines client, 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 role have this permission, while users with the Senior Developer or 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. For more general information about permissions in Acquia Cloud, see Working with roles and permissions.

Installing with Acquia Dev Desktop

The 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 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 pipelines client directory (/Applications/DevDesktop/tools) is in your PATH.

Installing from the command prompt

You can also install the pipelines client from the command prompt 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 pipelines client executable in your PATH, we recommend using the Acquia Dev Desktop installer.

Configuring the client (authentication)

After you have installed the pipelines client, you must configure the client with an Acquia Cloud API token. This enables the client to authenticate with Acquia Cloud.

Pipelines users are required to create an API token before starting a job. If an application does not currently have an API token attached, or the user does not have an API token, the user will be asked to create a token and attach it to the application.

You can obtain the Acquia Cloud API token from the Acquia Cloud interface by completing the following steps:

  1. Sign in to Acquia Cloud.

  2. Click the avatar in the upper right to open your profile, and then click API tokens in the left sidebar. Or, go directly to cloud.acquia.com/app/profile/tokens.

  3. Click the Create Token button to add an API token:

    Create token button

  4. In the Create API Token dialog box, enter a label for the token, such as Pipelines CLI Client. 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.

    Important

    Do not close the dialog box until you record the API secret. Because you cannot display the API secret at a later time, be sure to configure the pipelines client with the API secret before you close the dialog box.

    If you lose the API secret, you must create another API token.

  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 the pipelines client with your codebase. Your credentials are stored at ~/.acquia/pipelines/credentials.

Updating the pipelines client

If you have already installed the pipelines client, run the pipelines self-update command to update your client to the latest available version. You can use the command pipelines --version to display your current version number.