Information for: DEVELOPERS   PARTNERS

Acquia CLI commands

Acquia CLI command list and help

Use the following commands to view a list of available commands, and the help for each command.

  • Run acli or acli list to view a list of all available commands and their description. Run acli api or acli api:list to view the commands that you can use to access the 200+ Cloud Platform API endpoints accessible from Acquia CLI.

  • Run acli help <command> or acli [command] --help to view additional information such as usage and options for a specific command.

    For example, if you run acli help ssh-key:create, you will get:

    Description:
      Create an SSH key on your local machine
    
    Usage:
      ssh-key:create [options]
    
    Options:
          --filename=FILENAME  The filename of the SSH key
          --password=PASSWORD  The password for the SSH key
      -h, --help               Display this help message
      -q, --quiet              Do not output any message
      -V, --version            Display this application version
          --ansi               Force ANSI output
          --no-ansi            Disable ANSI output
      -n, --no-interaction     Do not ask any interactive question
      -v|vv|vvv, --verbose     Increase the verbosity of messages: 1 for
                               normal
                               output, 2 for more verbose output and 3 for
                               debug
    

List of commands

Acquia CLI includes the following commands:

Command Description
acli clear-caches Clears local Acquia CLI caches
acli help Displays help for a command
acli link Associates your project with a Cloud Platform application
acli list Lists commands
acli new Creates a new Drupal project
acli telemetry Toggles anonymous sharing of usage and performance data
acli unlink Removes local association between your project and a Cloud Platform application
acli api:accounts List all API commands for the accounts resource
acli api:agreements List all API commands for the agreements resource
acli api:applications List all API commands for the applications resource
acli api:colors List all API commands for the colors resource
acli api:distributions List all API commands for the distributions resource
acli api:environments List all API commands for the environments resource
acli api:ide List all API commands for the ide resource
acli api:identity-providers List all API commands for the identity-providers resource
acli api:insights List all API commands for the insights resource
acli api:invites List all API commands for the invites resource
acli api:list List all API commands
acli api:messages List all API commands for the messages resource
acli api:notifications List all API commands for the notifications resource
acli api:options List all API commands for the options resource
acli api:organizations List all API commands for the organizations resource
acli api:permissions List all API commands for the permissions resource
acli api:subscriptions List all API commands for the subscriptions resource
acli api:tps List all API commands for the tps resource
acli api:list Displays the list of API commands. Run api:list to see them all
acli auth:login Register your Cloud API key and secret to use API functionality
acli auth:logout Removes Cloud API key and secret from local machine
acli ide:create Creates a Cloud IDE for development
acli ide:delete Deletes a Cloud IDE
acli ide:info Prints information about a Cloud IDE
acli ide:list Lists the available Cloud IDEs
acli ide:open Opens a Cloud IDE in your browser
acli log:tail Tails the logs from your environments
acli remote:aliases:download Downloads drush aliases for Cloud Platform environments
acli remote:aliases:list Lists all aliases for Cloud Platform environments
acli remote:drush Runs a Drush command remotely on an application’s environment
acli remote:ssh Opens a new SSH connection to a Cloud Platform environment
acli self-update Updates Acquia CLI to the latest version
acli ssh-key:create Creates an SSH key on your local machine
acli ssh-key:create-upload Creates an SSH key on your local machine and uploads it to Cloud Platform
acli ssh-key:delete Deletes an SSH key
acli ssh-key:list Lists your local and remote SSH keys
acli ssh-key:upload Uploads a local SSH key to Cloud Platform

In Acquia Cloud IDE, more commands are available:

Command Description
acli pull:all Copy code, database, and files from a Cloud Platform environment
acli pull:code Copy code from a Cloud Platform environment
acli pull:database Import latest database backup from a Cloud Platform environment
acli pull:files Copy files from a Cloud Platform environment
acli pull:run-scripts Execute post pull scripts
acli push:code Push code from your IDE to a Cloud Platform environment
acli push:database Push a database from your IDE to a Cloud Platform environment
acli push:files Push Drupal files from your IDE to a Cloud Platform environment
acli ide:php-version Changes the PHP version in the current IDE
acli ide:share Gets the share URL of a Cloud IDE
acli ide:wizard:ssh-key:create-upload Wizard to perform first time setup tasks within an IDE
acli ide:wizard:ssh-key:delete Wizard to delete SSH key for IDE from Cloud
acli ide:xdebug-toggle Toggles xDebug on or off in the current IDE