-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
19bc15c
commit fe86843
Showing
1 changed file
with
3 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,11 @@ | ||
|  [](https://codecov.io/github/acquia/cli) [](https://dashboard.stryker-mutator.io/reports/github.com/acquia/cli/main) | ||
| # Acquia CLI | ||
|
|
||
| The official command-line tool for interacting with the Drupal Cloud Platform and services. Acquia CLI (ACLI) helps you run [Drush](http://www.drush.org/) commands and tail logs from your Acquia-hosted applications, manage [Acquia Cloud IDEs](https://docs.acquia.com/dev-studio/ide/), create and manage teams and applications via the [Cloud Platform API](https://cloudapi-docs.acquia.com/), and much more! | ||
| The official command-line tool for interacting with the Acquia Cloud Platform and services. Acquia CLI (acli) helps you run [Drush](http://www.drush.org/) commands and tail logs from your Acquia-hosted applications, manage [Acquia Cloud IDEs](https://docs.acquia.com/dev-studio/ide/), create and manage teams and applications via the [Cloud Platform API](https://cloudapi-docs.acquia.com/), 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](https://docs.acquia.com/dev-studio/ide/) or third-party tools such as [Lando](https://lando.dev/). | ||
| Acquia CLI is not a local development environment. If you are looking for an integrated development environment, consider [Acquia Cloud IDE](https://docs.acquia.com/dev-studio/ide/) or third-party tools such as [Lando](https://lando.dev/). | ||
|
|
||
|
|
||
| ## Installation | ||
| ## Installation and usage | ||
|
|
||
| Install instructions and official documentation are available at https://docs.acquia.com/acquia-cli/install/ | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ### Interact with Cloud API | ||
|
|
||
| Trying Using [jq](https://stedolan.github.io/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](https://github.com/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](https://docs.acquia.com/acquia-cloud/develop/pipelines/cli/): Provides an interface for managing [Acquia Pipelines](https://docs.acquia.com/acquia-cloud/develop/pipelines) jobs. Acquia CLI does not allow you to manage Pipelines jobs, although this functionality is in the roadmap. | ||
| - [Typhonius Acquia CLI](https://github.com/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](https://github.com/acquia/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. | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| | Version | Supported | | ||
| | ------- | ------------------ | | ||
| | 2.x | :white_check_mark: Supported | | ||
| | 1.x | :warning: Minimally supported | | ||
| | < 1.x | :x: Not supported | |