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 Cloud Platform.
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 version 7.4, 8.0, 8.1 or 8.2 available in your local work environment.
Permission
To use the Pipelines client, you must have the Execute pipelines permission for the Cloud Platform 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 Cloud Platform interface. For more general information about permissions in Cloud Platform, see Working with roles and permissions.
Installing from the command prompt
You can install the Pipelines client from the command prompt by using the following command:
curl -o pipelines https://cloud.acquia.com/pipeline-client/download
chmod a+x pipelines
Move the pipelines program to a directory in your PATH.
Configuring the client (authentication)
After you have installed the Pipelines client, you must configure the client with a Cloud Platform API token. This enables the client to authenticate with Cloud Platform.
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.
To obtain the Cloud Platform API token from the Cloud Platform user interface:
- Sign in to the Cloud Platform user interface.
Click the avatar in the upper right to open your profile, and click Account Settings.
The Profile page is displayed.
- In the top menu, click API Tokens. Alternatively, access cloud.acquia.com/app/profile/tokens.
Click Create Token to add an API token:
- 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. 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 Cloud Platform interface.
Important
Do not close the dialog box until you record the API secret. Since 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.
In a separate command prompt window, run the following command:
pipelines configure- Copy and paste the API key and API secret you previously obtained in this procedure to the
pipelines configurecommand 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.