Information for: DEVELOPERS   PARTNERS

Dev Studio CLI commands

Important

Dev Studio CLI will reach end-of-life on March 30, 2021. Acquia will no longer support Dev Studio CLI after March 30, 2021. Dev Studio CLI is replaced by Acquia CLI and Acquia Cloud IDE. Acquia recommends you to move from Dev Studio CLI to Acquia CLI and Acquia Cloud IDE which are more secure, reliable, and scalable.

Dev Studio CLI includes the following commands:

Command Description
ads api:setup Set up credentials for utilizing the Cloud Platform API.
ads autocomplete [SHELL] Display autocomplete installation instructions.
ads browse [ENVIRONMENT] Open the current local website in your browser.
ads clone [REPO] [DIRECTORY] Clone an existing project and start up an environment for you to work on.
ads deploy Deploy your changes to a remote environment.
ads destroy Destroy the environment in the current folder.
ads feedback Sends feedback about Dev Studio to Acquia.
ads help [COMMAND] Display help for Dev Studio CLI.
ads ide:create Create a Cloud IDE for development.
ads ide:delete Delete a Cloud IDE.
ads ide:list List available Cloud IDEs for an application.
ads ide:open Open a Cloud IDE.
ads init Initialize a project for use with the command line.
ads link Link your project with one of your Cloud Platform applications.
ads logs:tail [ENVIRONMENT] Tail the logs from your environment.
ads logs:tail-db-log Tail the Drupal watchdog log on your local environment.
ads new [NAME] Create a new Drupal environment and installs your project.
ads refresh [ENVIRONMENT] Copy database and files from one environment to another.
ads run Run various tools within your environment.
ads run blt [COMMAND] Display a full list of BLT commands. With an argument, run Acquia BLT commands using the local environment.
ads run drush [COMMAND] Display a full list of Drush commands. With an argument, run the specified Drush command on the local environment or (with a site alias) on a specified environment.
ads service:add [SERVICE] Add a service to the local development environment.
ads service:remove [SERVICE] Remove a service from the local development environment.
ads ssh-key:create Create an SSH key on your local machine.
ads ssh-key:delete [NAME] Delete a SSH key.
ads ssh-key:list Return your local and remote SSH keys.
ads ssh-key:upload Upload a public SSH key to Acquia.
ads start Start your local development environment.
ads stop Stop your local development environment.
ads telemetry Enable or disable anonymous sharing of usage and performance data. Sharing your anonymized usage and performance can help Acquia improve Dev Studio.
ads test Run automated tests locally.
ads uninstall Uninstall Dev Studio CLI.
ads update Update Dev Studio CLI.

Command details

ads api:setup

Arguments None
Options None
Examples None

ads autocomplete [SHELL]

Arguments SHELL  shell type
Options -r, --refresh-cache: Refresh cache (ignores displaying instructions).
Examples
  • ads autocomplete
  • ads autocomplete bash
  • ads autocomplete zsh
  • ads autocomplete --refresh-cache

ads browse [ENVIRONMENT]

Arguments ENVIRONMENT: The environment or full Drush site alias you want to browse. (Default value: local)
Options None
Examples None

ads clone [REPO] [DIRECTORY]

Arguments
  • REPO: The Git repository you want to clone and install.
  • DIRECTORY: The directory where you want to set up the project.
Options
  • -e, --environment=drupalvm|lando: The environment in which you want to set up your project.
  • --verbose: Display all command output.
Examples
  • ads clone YOUR_GIT_REPO_URL
  • ads clone YOUR_GIT_REPO_URL --environment lando: Use Lando as your project’s environment.
  • ads clone YOUR_GIT_REPO_URL DIRECTORY_NAME: Clones YOUR_GIT_REPO_URL in DIRECTORY_NAME.

ads deploy

Arguments None
Options
  • -a, --application=application: The remote application to deploy to.
  • -e, --environment=environment: The remote environment to deploy to.
  • -o, --[no-]open: Open the website in browser after the deploy is complete.
  • -t, --tag=tag: The tag (version) you want to deploy, create new or existing.
  • --verbose: Display all command output.
  • --override: Override this command.
  • --delete-override: Remove a previous override of this command.
Examples None

ads destroy

Arguments None
Options
  • -y, --yes: Respond yes to all Y/n prompts.
  • --verbose: Display all command output.
Examples None

ads feedback

Arguments None
Options None
Examples None

ads help [COMMAND]

Arguments COMMAND: Command to display help for.
Options --all: List all commands in Dev Studio CLI.
Examples None

ads ide:create

Arguments None
Options
  • -a, --application=APPLICATION: The application associated with the IDE.
  • -h, --help: Display context-sensitive help.
  • -l, --label=LABEL: A label for your remote IDE.
  • -o, --[no-]open: Open the IDE in a browser after it’s complete.
  • --verbose: Display all command output.
Examples None

ads ide:delete

Arguments None
Options
  • -a, --application=APPLICATION: The application associated with the IDE.
  • -h, --help: Display context-sensitive help.
  • --verbose: Display all command output.
Examples ads ide:delete explains how to delete an IDE.

ads ide:list

Arguments None
Options
  • -a, --application=APPLICATION: The application associated with the IDE.
  • -h, --help: Display context-sensitive help.
  • --verbose: Display all command output.
Examples ads ide:list: Returns all the IDEs for an application.

ads ide:open

Arguments None
Options
  • -a, --application=APPLICATION: The application associated with the IDE.
  • -h, --help: Display context-sensitive help.
  • --verbose: Display all command output.
Examples ads ide:open

ads init

Arguments None
Options
  • -e, --environment=lando|drupalvm: The environment in which you want to set up your project.
  • --verbose: Display all command output.
Examples ads init --environment lando: Initialize the project with Lando as your environment.

ads logs:tail [ENVIRONMENT]

Arguments ENVIRONMENT: The environment or full Drush site alias for which you want to tail logs. (Default value: local)
Options
Examples ads link --application my-app: Links your project with your my-app application from Cloud Platform.

ads logs:tail-db-log

Arguments None
Options -n, --pastLines=pastLines The number of lines from the past to output. (Default value: 10)
Examples None

ads new [NAME]

Arguments NAME: The project name. Letters and numbers are allowed.
Options
  • -b, --[no-]blt: Use Acquia BLT.
  • -d, --distribution=distribution: The Drupal distribution to
    download.
  • -e, --environment=drupalvm|lando: The environment in
    which you want to set up your project. (Default value: lando)
  • -h, --help: Display Dev Studio CLI help.
  • -l, --[no-]link: Link to a Cloud Platform application.
  • -p, --profile=profile: The Drupal profile to install.
  • --[no-]destroy-on-failure: Destroy created files in case of
    command failure.
  • --verbose: Display all command output.
Examples
  • ads new --environment lando: Creates a Lando environment for a Drupal project.
  • ads new --environment drupalvm: Creates a Drupal VM environment for a Drupal project.

ads refresh [ENVIRONMENT]

Arguments ENVIRONMENT: The target environment. (Default value: local)
Options
  • -a, --application=application: The Cloud Platform application name.
  • -f, --from=from: The source environment. (Default value: dev)
  • -o, --[no-]open: Open the website in a browser after the refresh is complete.
  • -w`, --[no-]wait: Wait for the operations on Cloud Platform to complete.
  • -y, --yes: Respond yes to all Y/n prompts.
  • --[no-]databases: Don’t refresh databases.
  • --[no-]files: Don’t refresh files.
  • --verbose: Display all command output.
Examples
  • ads refresh: Refresh local from dev.
  • ads refresh --from prod: Refresh local from prod.
  • ads refresh dev --from prod: Refresh dev from prod.
  • ads refresh --no-files: Refresh local from dev without files.
  • ads refresh --no-databases: Refresh local from dev without databases.

ads run

Arguments None
Options None
Examples
  • ads run drush [arguments]
  • ads run blt [arguments]
  • ads run composer [arguments]

ads run blt [COMMAND]

Arguments COMMAND: Any BLT command (for example, ads run blt sync).
Options None
Examples
  • ads run blt [args]: Runs BLT with the given arguments.
  • ads run blt: Display all available Drush commands.

ads run drush [COMMAND]

Arguments None
Options None
Examples
  • ads run drush [args]: Runs Drush with the given arguments.
  • ads run drush aliases:sync: Downloads Drush aliases
  • ads run drush: Display all available Drush commands.
  • ads run drush browse: Opens the project in your browser.
  • ads run drush uli: Generates a one-time sign-in link for your project.

Note

If no site alias is provided, all Drush commands will use the local environment.

ads service:add [SERVICE]

Arguments SERVICE: The service to add. Options: memcached, solr
Options
  • -e, --environment=environment: The environment to add the service from. (Default value: local)
  • --verbose: Display all command output.
Examples None

ads service:remove [SERVICE]

Arguments SERVICE: The service to remove. Options: memcached, solr
Options
  • -e, --environment=environment: The environment to remove the service from. (Default value: local)
  • --verbose: Display all command output.
Examples None

ads ssh-key:create

Arguments None
Options
  • -n, --password=password: The password for the key.
  • -p, --path=path: Where to save the key.
Examples None

ads ssh-key:delete [NAME]

Arguments NAME: The private key file name.
Options
  • -l, --local: Delete the local key.
  • -r, --remote: Delete the remote key.
Examples None

ads ssh-key:list

Arguments None
Options None
Examples None

ads ssh-key:upload

Arguments
  • -k, --key=key: Path to a public SSH key.
  • -l, --label=label: A label for the uploaded key.
Options None
Examples None

ads start

Arguments None
Options
  • --verbose: Display all command output.
Examples ads start

ads stop

Arguments None
Options
  • --verbose: Display all command output.
Examples ads stop

ads telemetry

Arguments None
Options
  • -h, --help: Display Dev Studio CLI help.
  • -l, --disable: Disable sharing of usage and performance. data.
Examples None

ads test

Arguments None
Options
  • --verbose: Display all command output.
  • --override: Override this command.
  • --delete-override: Remove a previous override of this command.
Examples None

ads uninstall

Arguments None
Options
  • -y, --yes: Respond yes to all Yes/no prompts.
  • --[no-]remove-configuration: Remove configuration files.
  • --verbose: Display all command output.
Examples None

ads update

Arguments None
Options None
Examples None