anujkaushal/cli

Acquia CLI

Acquia CLI

The official command-line tool for interacting with the Drupal Cloud Platform and services. Acquia CLI helps you run Drush commands and tail logs from your Acquia-hosted applications, manage Acquia Cloud IDEs, create and manage teams and applications via the Cloud Platform API, and much more!

Acquia CLI does not provide or manage local development environments. If you are looking for a packaged development environment, consider Acquia Cloud IDE or third-party tools such as Lando.

Installation

Install instructions and official documentation are available at https://docs.acquia.com/dev-studio/acquia-cli/install/

Example Usage

Interact with Cloud API

Trying Using jq to highlight and parse JSON output from acli api commands.

// Get a list of all Acquia Cloud Platform applications that you have access to.
$ acli api:applications:list
// Do the same, but highlight the JSON output.
$ acli api:applications:list | jq
// Output only the "name" field for every object in the JSON output.
$ acli api:applications:list | jq '.[] | .name'
// Output only the first object in the JSON output.
$ acli api:applications:list | jq '.[0]'

Manage SSH keys

// Create a new SSH key locally and upload it to Acquia Cloud Platform.
$ ssh-key:create-upload
// List all local and remote SSH keys.
$ acli ssh-key:list

Manage IDEs

// Create a new Acquia Cloud IDE
$ acli ide:create
// List existing IDEs.
$ acli ide:list
// Open an IDE in your web browser.
$ acli ide:open

Interact with Acquia Cloud Platform Environments

// List aliases for all environments.
$ acli remote:aliases:list
// SSH into an environment.
$ acli ssh myapp.dev
// Run a drush command in an environment.
$ acli drush myapp.dev cache-rebuild

Hook into ACLI commands

You may define scripts that will automatically run before and/or after any ACLI command. To do so, add a script to your root composer.json file following the naming pattern (pre|post)-acli-(command name with dashes). E.g., pre-acli-push-db or post-acli-pull-files. The script must be named correctly in order to be executed. See examples below:

"scripts": {
        "pre-acli-pull-db": [
            "echo \"I'm pulling the database now!\""
        ],
        "post-acli-pull-db": [
            "echo \"I'm done pulling the database!\""
        ],
    }

Authentication

The preferred way to authenticate with Acquia Cloud Platform API is to run acli auth:login. However, ACLI supports other methods of authentication. In priority order, ACLI will accept the following:

1. An access token stored in the ACLI_ACCESS_TOKEN environment variable with its corresponding ACLI_ACCESS_TOKEN_EXPIRY value.
2. An ACLI_KEY environment variable and its corresponding ACLI_SECRET.
3. Values defined in ~/.acquia/cloud_api.conf as generated by the acli auth:login command.

Similar tools

Several tools compliment or duplicate Acquia CLI functionality. Acquia CLI can safely be used with any of these tools, although some functionality may be duplicated.

• Acquia BLT: Provides an automation framework for setting up and managing Drupal applications. Acquia BLT is installed in a Drupal application and provides support for just that application, while Acquia CLI should be installed globally and allows you to interact with any Acquia service. Acquia CLI is not an automation framework like Acquia BLT.
• Pipelines CLI: Provides an interface for managing Acquia Pipelines jobs. Acquia CLI does not allow you to manage Pipelines jobs, although this functionality is in the roadmap.
• Typhonius Acquia CLI: Provides just an interface for Cloud API. Acquia CLI (acquia/cli) is a superset of this functionality, with access to the Cloud API as well as Acquia services not part of Cloud API.
• ACSF tools: Provides Drush commands for interacting with ACSF. Duplicates some functionality of Acquia CLI, but in the form of Drush commands rather than a standalone CLI.

Development / contribution

Contributions to Acquia CLI are welcome subject to the contributions policy, which also has more detailed information on how to develop Acquia CLI.

Support

Please refer to our Support Users Guide for more information on products and services we officially support.