Information for: DEVELOPERS   PARTNERS

Getting started with Dev Studio

This guide provides you with steps to create a new Drupal project on your local machine, with a new Cloud Platform account, after you have installed Dev Studio CLI.

To create or deploy an application with Dev Studio CLI, you must have already completed the installation requirements.

Note

Dev Studio CLI is incompatible with Drupal 7.

Creating a new application with Dev Studio CLI

Dev Studio CLI provides commands to create a new Drupal application linked to a Cloud Platform application and ready for Drupal development. When creating a project, Dev Studio CLI uses Composer to confirm if installation requirements, such as Drush 9 and (optionally) Acquia BLT, are met.

Commands for existing codebases

  • Existing projects with a remote codebase should use the ads clone [REPO] [DIRECTORY] command instead of ads new [NAME].
  • Existing projects with only a local codebase should use the ads init command instead of ads new.

To create a new Drupal 8 application with the ads new command in Dev Studio CLI, complete the following steps:

  1. Open a command-prompt window on your local computer.

  2. Run the following command:

    ads new
    
  3. For Project name, enter a descriptive name that contains only numbers and lowercase letters.

  4. For Environment, click the local development framework you have installed and want to use with this application from the following options:

    Note

    The development framework you select must already be installed on your local machine.

  5. Press Enter to complete your selection.

  6. If sudo on your local computer requires a password, Dev Studio CLI will prompt you to determine if you have the required sudo access to continue. Enter Yes or No, based on the situation.

    Dev Studio CLI will display a list of installation steps it’s performing, and then begin to create your local Drupal project.

    Note

    These steps may take some time. As steps complete, they will be marked with a green check mark.

  7. (Lando installations only): For the prompt Do you want to include BLT to streamline your development process?, enter Yes or No, based on the situation. If you don’t include Acquia BLT, your project structure is created with composer create-project, and project dependencies are installed with composer install.

    For more information about Acquia BLT, see its documentation.

  8. For the prompt Which installation profile do you want to use?, select from one of the following options:

    • Acquia Lightning: An Acquia-curated set of Drupal modules. If you didn’t include Acquia BLT in the previous step, this option is selected. For more information, see Lightning.
    • Standard: The Standard profile (included with Drupal core) has core modules and themes, but doesn’t include Acquia Lightning.
    • Minimal: The Minimal profile, included with Drupal core, and includes no default modules or themes.
  9. Optional, but required to use all features: For the prompt Do you want to open this page to generate a token now?, enter Yes to open https://cloud.acquia.com/a/profile/tokens in a new browser window to create a new API key and secret. For more information, see Generating an API token.

    1. For the prompt Please enter your API Key, paste your API key, and then press Enter.
    2. For the prompt Please enter your API Secret, paste your API secret, and then press Enter. Cloud Platform doesn’t display your API Secret.
  10. Optional, but required to use all features: For the prompt Do you want to link to an existing Acquia Cloud project now?, enter Yes or No.

    If you enter Yes, Dev Studio CLI displays a list of the human-readable names and sitenames of the Cloud Platform applications to which you have permission to access.

If you provided an API key, API secret, and linked your installation to an existing Cloud Platform application, Dev Studio CLI’s Drush synchronization synchronizes your Drush aliases between the chosen application and your local environment.

Using an external repository

To use an external repository for development, such as Github or Bitbucket, you can add your external repository as a remote. After completing the steps for ads new, run the command git add remote [REMOTE NAME] [REMOTE URL], replacing [REMOTE NAME] and [REMOTE URL] with values appropriate for your repository.