Acquia Copilot is a conversational AI connected into our product documentation and knowledge base. Ask Copilot about product features, technical details, troubleshooting and how to get started with Acquia products.
If you work from Cloud IDE or have Acquia CLI installed locally, you might not need Drush aliases.
Acquia CLI offers the following remote:drush command to abstract out having Drush and Drush aliases installed:
$ acli remote:drush myapp.dev status -- --fields=drupal-version
The command returns the following output, where <version> refers to the version of your Drupal application.
Drupal version : <version>
The current Drupal version requires Drush version 11 or later. Newer versions of Drush, that is, version 11 and later, must be installed via Composer. Acquia does not manage the update to the newer versions. For more information, see About Drush on Cloud Platform.
Cloud Platform defines Drush aliases for all your application’s environments. For example, the application named (Cloud Platform username) example has the following Drush aliases for its Development, Staging, and Production environments:
example.dev
example.test
example.prod
Your environments may not all be on the same infrastructure, depending on your account and configuration. Using Drush’s remote command capability, you can use any of the aliases to access any of your applications from your local computer or any Cloud Platform infrastructure. The remote aliases work seamlessly if you have your SSH private key available on the source infrastructure. To use your SSH private key from Cloud Platform without having to copy the private key to the Cloud Platform infrastructure, use SSH key forwarding by using the -A argument to SSH when connecting from your local computer.
For the following examples, the Staging environment is on infrastructure staging-1``andyourProductionenvironmentison``web-1, web-2, and web-3.
Note
If you have more than one subscription using the same name, your Drush aliases will use the same namespace and overwrite each other.
Click your user avatar in the upper-right corner, and click Account Settings.
Click Drush.
Based on whether you are using the Cloud Platform user interface or Acquia CLI, perform the steps in either of the following tabs:
For Drush 8:
In Drush integration, click the link for downloading Drush 8 aliases in the PHP format.
Extract the downloaded archive file into $HOME:
$ tar -C $HOME -xf $HOME/Downloads/cloud-platform.drush-8-aliases.tar.gz
:
Use the aliases on your local command line as though you’re signed in to your Cloud Platform infrastructure to view the Drush status. For example:
drush @example.test status
Note
Microsoft Windows users may need to edit their $PATH variable to use Drush. You can resolve the issue by editing the path manually.
Don’t add files from your .drush aliases directory to your Cloud Platform infrastructure’s home directory. The Drush alias files include a remote-host setting that enables them to function from your local computer, but which can prevent SSH connections if it’s present on your Cloud Platform infrastructure.
Example: Viewing site status with Drush
To view the status of your application on the production environment from your local computer using Drush, enter the following command:
drush @example.prod status
Note
Depending on the age of your subscription, there are two available formats for remote-host. Ensure you examine your alias file to check whether one of the following correct formats is in use, when needed:
[subscriptionname][env].ssh.prod.acquia-sites.com
serverrname-nnnn.prod.hosting.acquia.com
Viewing site status using Drush and SSH forwarding
By signing in to a Cloud Platform infrastructure with SSH forwarding, you can access all your environments without copying your private key to Cloud Platform. To log in to the staging environment with SSH forwarding, run the following command:
To view the Drush status for your production website while you’re signed in to the infrastructure for your staging environment, enter the following command, replacing infrastructure names as appropriate:
drush @example.prod status
Refreshing Drush aliases
From time to time, your Drush aliases may change if your infrastructure (and hostname of your Cloud Platform) was changed. For example, your Drush aliases may change if you relaunch or resize your infrastructure. The aliases may also change if you upgrade your subscription from Cloud Platform Professional to Cloud Platform Enterprise.
You can refresh your Drush aliases by downloading them again, and pasting the new version in place of the old one. As an alternative, you can use the following Drush command:
If you work from Cloud IDE or have Acquia CLI installed locally, you might not need Drush aliases.
Acquia CLI offers the following remote:drush command to abstract out having Drush and Drush aliases installed:
$ acli remote:drush myapp.dev status -- --fields=drupal-version
The command returns the following output, where <version> refers to the version of your Drupal application.
Drupal version : <version>
The current Drupal version requires Drush version 11 or later. Newer versions of Drush, that is, version 11 and later, must be installed via Composer. Acquia does not manage the update to the newer versions. For more information, see About Drush on Cloud Platform.
Cloud Platform defines Drush aliases for all your application’s environments. For example, the application named (Cloud Platform username) example has the following Drush aliases for its Development, Staging, and Production environments:
example.dev
example.test
example.prod
Your environments may not all be on the same infrastructure, depending on your account and configuration. Using Drush’s remote command capability, you can use any of the aliases to access any of your applications from your local computer or any Cloud Platform infrastructure. The remote aliases work seamlessly if you have your SSH private key available on the source infrastructure. To use your SSH private key from Cloud Platform without having to copy the private key to the Cloud Platform infrastructure, use SSH key forwarding by using the -A argument to SSH when connecting from your local computer.
For the following examples, the Staging environment is on infrastructure staging-1``andyourProductionenvironmentison``web-1, web-2, and web-3.
Note
If you have more than one subscription using the same name, your Drush aliases will use the same namespace and overwrite each other.
Click your user avatar in the upper-right corner, and click Account Settings.
Click Drush.
Based on whether you are using the Cloud Platform user interface or Acquia CLI, perform the steps in either of the following tabs:
For Drush 8:
In Drush integration, click the link for downloading Drush 8 aliases in the PHP format.
Extract the downloaded archive file into $HOME:
$ tar -C $HOME -xf $HOME/Downloads/cloud-platform.drush-8-aliases.tar.gz
:
Use the aliases on your local command line as though you’re signed in to your Cloud Platform infrastructure to view the Drush status. For example:
drush @example.test status
Note
Microsoft Windows users may need to edit their $PATH variable to use Drush. You can resolve the issue by editing the path manually.
Don’t add files from your .drush aliases directory to your Cloud Platform infrastructure’s home directory. The Drush alias files include a remote-host setting that enables them to function from your local computer, but which can prevent SSH connections if it’s present on your Cloud Platform infrastructure.
Example: Viewing site status with Drush
To view the status of your application on the production environment from your local computer using Drush, enter the following command:
drush @example.prod status
Note
Depending on the age of your subscription, there are two available formats for remote-host. Ensure you examine your alias file to check whether one of the following correct formats is in use, when needed:
[subscriptionname][env].ssh.prod.acquia-sites.com
serverrname-nnnn.prod.hosting.acquia.com
Viewing site status using Drush and SSH forwarding
By signing in to a Cloud Platform infrastructure with SSH forwarding, you can access all your environments without copying your private key to Cloud Platform. To log in to the staging environment with SSH forwarding, run the following command:
To view the Drush status for your production website while you’re signed in to the infrastructure for your staging environment, enter the following command, replacing infrastructure names as appropriate:
drush @example.prod status
Refreshing Drush aliases
From time to time, your Drush aliases may change if your infrastructure (and hostname of your Cloud Platform) was changed. For example, your Drush aliases may change if you relaunch or resize your infrastructure. The aliases may also change if you upgrade your subscription from Cloud Platform Professional to Cloud Platform Enterprise.
You can refresh your Drush aliases by downloading them again, and pasting the new version in place of the old one. As an alternative, you can use the following Drush command:
Cloud Platform