Getting started with Cloud IDE¶

Creating a Cloud IDE through the Cloud Platform user interface¶

To create a Cloud IDE through the Cloud Platform user interface:

1. Sign in to the Cloud Platform user interface and visit your application dashboard.

2. Go to Actions > Create Cloud IDE.

   

3. Specify a name for your IDE and click Submit.

   

   While the IDE gets provisioned, the system displays a spinner on the card. The IDE is available within a few minutes.

   

   After the IDE is ready, the updated card displays the IDE URL and the owner.

4. To launch the IDE in a new tab, click Launch Cloud IDE.

   

Creating a Cloud IDE by using Acquia CLI¶

To create a Cloud IDE by using Acquia CLI:

1. Install Acquia CLI

2. Sign in to the Cloud Platform user interface.

3. Open your local terminal application.

4. From the command line, authenticate against the Cloud Platform API and follow the prompts.

   Note

   If you have already authenticated against the Cloud Platform API or if you are creating an IDE from a Cloud IDE, you do not need to authenticate again.

   acli auth:login
   

5. From the command line, create the Cloud IDE and follow the prompts.

   acli ide:create
   

After the IDE is created, Acquia CLI displays a link to your IDE and a link to the Drupal application hosted in the IDE. You can open your IDE at any time by running the following command from your terminal and selecting the IDE you want to open:

acli ide:open

Review all commands to manage your IDE lifecycle. After you create a Cloud IDE, you are automatically authenticated with the Cloud Platform API.

For information about changing preferences in Cloud IDE, see Settings and preferences.

Configuring your IDE from the Cloud Platform user interface¶

To configure your IDE from the Cloud Platform user interface:

1. From the Cloud Platform application page, identify the relevant Cloud IDE card and click Launch Cloud IDE.

2. On the Get Started page, click CONFIGURE IDE to connect the IDE to your Cloud Platform account. This automatically generates an SSH key that is linked to your Cloud Platform user account.

   

Configuring your IDE by using Acquia CLI¶

To configure your IDE by using Acquia CLI:

1. From the command line on your local computer, run the following command to open your IDE and select the IDE you want to open:

   acli ide:open
   

2. On the Get Started page, click CONFIGURE IDE to connect the IDE to your Cloud Platform account. This automatically generates an SSH key that is linked to your Cloud Platform user account.

   

Creating or cloning a Drupal application into your IDE¶

After you create and configure your IDE, you can either create a Drupal application or clone your Cloud Platform application into the IDE.

Cloning your application from a GitHub repository to your IDE¶

To clone your application from a GitHub repository into your IDE, complete the following steps:

1. Copy the contents of your IDE SSH public key at /home/ide/.ssh/id_rsa_acquia_ide_<UUID>. Make sure to replace the following example code with your own IDE SSH public key:

   $ cat /home/ide/.ssh/id_rsa_acquia_ide_<UUID>.pub
   ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDia6OKJKFQYmQysWWL6+bRpjfGbGHaYx3b9mdqhRxtBr9
   +q1TUUljNPX3dT6y+GsQEC4ImAhm82fPpFjEpwPGrM5+kvlk4zkLMV+TILnQXA9athf3CWPTCUQxyY9t5ZO
   wbmjRPhFeDKCVogSAjHdCoVRQfKOy1J0ffO+I7nnjVNbhMLfeL1PU1WZhyx4tBRweKX44QZA1hccrIfw0SV
   rXnJ72Gm/0SESnCaAkfnEjo8+wwyiSNfTFOfY/MrgkNjePaxTPP0LaFwoiGpfyNRNAd6w+ztfIQa34kfviT
   NCp4Us/cGrtLH6AYvrtVbIwToNdXvTPliz+D1GJYcaWlbfdwHselKDQffVbnYLbpgopWgDJjmy/ex0TG4Gv
   Qnn1CVHZayKbivuVT0sEgcWrOmyKcqpO2PlZ+W4SCpCdQZ3Tz6I0I+O9VKLF2lauKtjHkmpfOxI46YkLEA8
   6sTuK3s9cyt8irn9X/4ggV7D4PbiYdaweQMjRgQPVhLcB+dosDml750bnEGjjY1iFJwIbT69gF5zucrheIr
   zr6OarwPjwW1V314sKfszssjSYpablgYYm/8zOjowKpgf+6XS0Ug0aKePWRPUVfSdnn5fDBEr9U3K4r3cv5
   L6Ol0GIJVcfEi7Vq6OsmDxgiEfAzKdpXaHZBwacpATrawZ0DQqr58V/xCw== ide@ide-68k71c55-4155-
   4ba0-b737-13187c3c8b96-6799564b7d-rbn58
   

2. Paste the SSH public key into the Key field on the Add new page.

   

3. You can clone your repository into the correct folder in the IDE with the following command, replacing [your-URL.git] with the Git URL of your repository:

   git clone [your-URL.git] /home/ide/project
   

   Note

   When pulling the code from an external Git repository, you can use acli refresh --no-code to only pull the database and files from your Cloud Platform application.

View your application within Cloud IDE by clicking Open Drupal Site in the admin menu. Then click Open site in a new tab to open the application in a new tab in your browser. Clicking Open Site in the IDE alone will open the application in the Preview pane.

Pushing your changes back to the Cloud Platform¶

Cloud IDE is primarily used to develop an existing Drupal application. But there are cases when you might need to push your database or files to the Cloud Platform, e.g. if you’re creating a new project. We’ve made this easy for you with Acquia CLI’s push sub-commands.

ide:~/project (master) $ acli push:code
Please use git to push code changes upstream.

ide:~/project (master) $ acli push:database
Using Cloud Application mydrupalapp

 Choose a Cloud Platform environment:
  [0] Dev, dev (vcs: pipelines-build-master)
  [1] Stage, test (vcs: tags/2020-10-19)
 > 1

 Choose a database [mydrupalapp (default)]:
  [0] mydrupalapp (default)
  [1] drupal9
 > 0

 Overwrite the mydrupalapp database on test with a copy of the database from the current machine? (yes/no) [yes]:
 > yes

    ✔ Creating local database dump
    ✔ Uploading database dump to remote machine
    ✔ Importing database dump into MySQL on remote machine

ide:~/project (master) $ acli push:files
Using Cloud Application mydrupalapp

 Choose a Cloud Platform environment:
  [0] Dev, dev (vcs: pipelines-build-master)
  [1] Stage, test (vcs: tags/2020-10-19)
 > 1

 Choose a site:
  [0] default
 > 0

 Overwrite the public files directory on test with a copy of the files from the current machine? (yes/no) [yes]:
 > yes

    ✔ Pushing public files directory to remote machine

Resetting your Cloud IDE workspace¶

Cloud IDEs are meant to be disposable, so you can create and delete them at will. However, when developing Drupal, it is sometimes faster to reset your working environment as if you were starting with a brand new Cloud IDE.

The Cloud IDE reset workspace feature not only takes care of automatically deleting your database, but also deletes your codebase and Drupal files directory under the /home/ide/project workspace.

To reset the Cloud IDE workspace:

1. On the Get Started page, click RESET WORKSPACE.

2. In the Terminal window that opens up, type y (or yes) and press Enter to proceed with the deletion.

   

   Note

   The Cloud IDE reset workspace does not delete anything on your Cloud Platform application, so there is no permanent data loss. It is only meant to delete the application that you have pulled or installed in Cloud IDE for convenience.