Application Launcher

This document provides the steps to perform the following:

Link your installation of Acquia CLI to the Cloud Platform API
Set up SSH access to your Cloud Platform environment

Note

To troubleshoot most of the error messages related to Acquia CLI, run the commands again using the --verbose option to diagnose issues.

Authenticating with Cloud Platform API

Before you use Acquia CLI, you must log in to your Cloud Platform account. You can log in with either of the following methods:

Method	When to use
Device code login (default)	You want to log in with your Acquia ID in a browser and you do not want to create or manage API keys.
API key and secret	You already have a Cloud Platform API token, or you must log in without a browser, such as in CI/CD pipelines or scripts.

Log in with a device code

To log in with a device code:

Run the following command:

acli auth:login

Acquia CLI displays a verification URL and a one-time code:

acli auth:login --no-interaction                              
Sign in to Acquia ID in your browser:
 https://id.acquia.com/activate
Then enter this code when prompted:
QGTMTDQK                                                                                                            
[INFO] Opening https://id.acquia.com/activate?user_code=QGTMTDQK                                               
Confirm the code above matches what appears in your browser before approving.
Waiting for authorization... (code expires in 10 minutes)
✓ Authenticated successfully.

Acquia CLI attempts to open the URL in your default browser. If the browser does not open, go to https://id.acquia.com/activate on any device.
On the Activate your device page, verify that the activation code matches the code in your terminal. If the field is empty, enter the code.
Click Next.
Sign in to your Acquia ID. You can use your email address and password, or select Sign in with Google. After you authenticate, the system activates the device and approves the request. For additional information, refer to Sign in with Google.
Return to your terminal. The terminal waits for approval and displays Authenticated successfull.

Note

The code expires after 10 minutes. If the code expires, run acli auth:login again to obtain a new code.

Important

Approve the request only if the code in your browser matches the code in your terminal. If you did not run the command, do not approve the request.

Log in with an API key and secret

To log in with an API key and secret, run the following command:

acli auth:login --use-legacy-auth

This command prompts you to open the page from which you can create a Cloud Platform API token in the Cloud Platform user interface.

If you use other Acquia products, such as Pipelines CLI, your machine might already be authenticated with the Cloud Platform, and you can reuse an existing token.

Setting up SSH access to Cloud Platform environments

To interact with Cloud Platform, you must generate and upload an SSH key. This allows you to access your Cloud Platform environments using SSH.

Run the following command:

acli ssh-key:create-upload

Next steps

For more information on Acquia CLI, see Acquia CLI commands.

This document provides the steps to perform the following:

Link your installation of Acquia CLI to the Cloud Platform API
Set up SSH access to your Cloud Platform environment

Note

To troubleshoot most of the error messages related to Acquia CLI, run the commands again using the --verbose option to diagnose issues.

Authenticating with Cloud Platform API

Before you use Acquia CLI, you must log in to your Cloud Platform account. You can log in with either of the following methods:

This document provides the steps to perform the following:

Link your installation of Acquia CLI to the Cloud Platform API
Set up SSH access to your Cloud Platform environment

Note

To troubleshoot most of the error messages related to Acquia CLI, run the commands again using the --verbose option to diagnose issues.

Authenticating with Cloud Platform API

Before you use Acquia CLI, you must log in to your Cloud Platform account. You can log in with either of the following methods:

Method	When to use
Device code login (default)	You want to log in with your Acquia ID in a browser and you do not want to create or manage API keys.
API key and secret	You already have a Cloud Platform API token, or you must log in without a browser, such as in CI/CD pipelines or scripts.

Log in with a device code

To log in with a device code:

Run the following command:

acli auth:login

Acquia CLI displays a verification URL and a one-time code:

acli auth:login --no-interaction                              
Sign in to Acquia ID in your browser:
 https://id.acquia.com/activate
Then enter this code when prompted:
QGTMTDQK                                                                                                            
[INFO] Opening https://id.acquia.com/activate?user_code=QGTMTDQK                                               
Confirm the code above matches what appears in your browser before approving.
Waiting for authorization... (code expires in 10 minutes)
✓ Authenticated successfully.

Acquia CLI attempts to open the URL in your default browser. If the browser does not open, go to https://id.acquia.com/activate on any device.
On the Activate your device page, verify that the activation code matches the code in your terminal. If the field is empty, enter the code.
Click Next.
Sign in to your Acquia ID. You can use your email address and password, or select Sign in with Google. After you authenticate, the system activates the device and approves the request. For additional information, refer to Sign in with Google.
Return to your terminal. The terminal waits for approval and displays Authenticated successfull.

Note

The code expires after 10 minutes. If the code expires, run acli auth:login again to obtain a new code.

Important

Approve the request only if the code in your browser matches the code in your terminal. If you did not run the command, do not approve the request.

Log in with an API key and secret

To log in with an API key and secret, run the following command:

acli auth:login --use-legacy-auth

This command prompts you to open the page from which you can create a Cloud Platform API token in the Cloud Platform user interface.

If you use other Acquia products, such as Pipelines CLI, your machine might already be authenticated with the Cloud Platform, and you can reuse an existing token.

Setting up SSH access to Cloud Platform environments

To interact with Cloud Platform, you must generate and upload an SSH key. This allows you to access your Cloud Platform environments using SSH.

Run the following command:

acli ssh-key:create-upload

Next steps

For more information on Acquia CLI, see Acquia CLI commands.

Run the following command:

acli auth:login

Acquia CLI displays a verification URL and a one-time code:

acli auth:login --no-interaction                              
Sign in to Acquia ID in your browser:
 https://id.acquia.com/activate
Then enter this code when prompted:
QGTMTDQK                                                                                                            
[INFO] Opening https://id.acquia.com/activate?user_code=QGTMTDQK                                               
Confirm the code above matches what appears in your browser before approving.
Waiting for authorization... (code expires in 10 minutes)
✓ Authenticated successfully.

Acquia CLI attempts to open the URL in your default browser. If the browser does not open, go to https://id.acquia.com/activate on any device.
On the Activate your device page, verify that the activation code matches the code in your terminal. If the field is empty, enter the code.
Click Next.
Sign in to your Acquia ID. You can use your email address and password, or select Sign in with Google. After you authenticate, the system activates the device and approves the request. For additional information, refer to Sign in with Google.
Return to your terminal. The terminal waits for approval and displays Authenticated successfull.

Authenticating with Cloud Platform API

Log in with a device code

Log in with an API key and secret

Setting up SSH access to Cloud Platform environments

Next steps

Authenticating with Cloud Platform API

Authenticating with Cloud Platform API

Log in with a device code

Log in with an API key and secret

Setting up SSH access to Cloud Platform environments

Next steps

Log in with a device code

Log in with an API key and secret

Setting up SSH access to Cloud Platform environments

Next steps

Did not find what you were looking for?

Did not find what you were looking for?

Getting started with Acquia CLI

Authenticating with Cloud Platform API

Log in with a device code

Log in with an API key and secret

Setting up SSH access to Cloud Platform environments

Next steps

Getting started with Acquia CLI

Authenticating with Cloud Platform API

Getting started with Acquia CLI

Authenticating with Cloud Platform API

Log in with a device code

Log in with an API key and secret

Setting up SSH access to Cloud Platform environments

Next steps

Log in with a device code

Log in with an API key and secret

Setting up SSH access to Cloud Platform environments

Next steps

Did not find what you were looking for?

Did not find what you were looking for?