Information for: DEVELOPERS   PARTNERS

Cloud IDE

Cloud IDE is a browser-based source code editor and a Drupal development stack running on the Cloud Platform.

Requirements

Cloud IDE requires that the following software is installed on your local computer:

  • Acquia CLI
  • The latest version of one of the following browsers:
    • Chrome
    • Edge
    • Firefox
    • Safari

Eligibility

Cloud IDE is available as an add-on feature for Cloud Platform subscriptions by contacting your Account Manager. If you don’t have an Account Manager, contact Acquia Sales.

Cloud IDE isn’t available for subscribers with specific regulatory or compliance requirements.

Getting started

After installing Acquia CLI, create a new Cloud IDE. You can then clone your Cloud Platform application into your IDE.

Managing existing IDEs

The following commands can help you manage your existing IDEs:

  • acli ide:list: Display a list of existing IDEs.
  • acli ide:open: Open an existing IDE in your web browser.
  • acli ide:delete: Delete an existing IDE.

Important

Deleting an IDE deletes all information, files, and databases from that environment. Acquia cannot recover this data.

Understanding the user interface

Cloud IDE displays the files and directories from your Drupal codebase in an Explorer pane on the left. Double-clicking on any file will open the source code editor on the right, providing access to viewing or modifying files.

For more information about the user interface, see Using Cloud IDE. For information about configuring preferences in the user interface, see Settings and preferences.

understanding_user_interface

Understanding IDE hibernation

Cloud IDE will automatically hibernate after 4 hours of inactivity. Once you access the IDE or Web preview again, Cloud IDE will automatically get out of hibernation and will be usable again after about 30 seconds.

Hibernation

IDE container resources

For a list of the tools, developer resources, and services available in the Cloud IDE container, see Resources in Cloud IDE.

Using the Cloud IDE terminal

Acquia Cloud IDE provides you with a terminal with access to the Bash shell. To learn more about using and configuring the terminal, see Using the terminal in Cloud IDE.

Working with PHP

The default PHP version for Cloud IDE is PHP 7.3. With Cloud IDE, you can configure the PHP version and Xdebug.

Configuring the PHP version

To configure the PHP version, complete the following steps:

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

    acli ide:open
    
  2. In your IDE admin menu, go to Terminal > New Terminal.

  3. Run the following command at the IDE terminal:

    acli ide:php-version <7.x>
    

    You can configure the PHP versions 7.3 and 7.4 as desired.

You can use the following command to check the current PHP version:

ide:~/project$ php -v
PHP 7.4.6 (cli) (built: Jun  1 2020 17:56:08) ( NTS )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies

Configuring PHP settings

To override the default PHP settings for Cloud IDE, you must change the following file:

/home/ide/configs/php/custom.ini

The PHP settings you can change include, but aren’t limited to the following:

  • memory_limit
  • upload_max_filesize
  • post_max_size
  • max_execution_time

Changes to PHP settings can display like the following example:

upload_max_filesize = 100M
post_max_size = 50M
max_execution_time = 240
memory_limit = 1G

To restart PHP-FPM to apply the changes you’ve made, run the following command:

acli ide:service-restart php

Enabling or disabling Xdebug

Cloud IDE allows you to enable and disable Xdebug with the acli ide:xdebug-toggle command.

ide:~/project $ acli ide:xdebug-toggle
xDebug enabled.
ide:~/project $ acli ide:xdebug-toggle
xDebug disabled.

Overriding Xdebug default settings (advanced)

To override the default settings, complete the following steps:

  1. In your Cloud IDE, locate the /home/ide/configs/php/xdebug.ini file.

  2. Modify any of the following configuration settings:

    [xdebug]
    ;zend_extension=xdebug.so
    xdebug.remote_enable=1
    xdebug.remote_autostart=1
    xdebug.remote_port=9001
    xdebug.auto_trace=Off
    xdebug.default_enable=Off
    xdebug.max_nesting_level=2000
    xdebug.profiler_enable=Off
    
  3. To apply the changes you’ve made, restart PHP-FPM by running the following command:

acli ide:service-restart php