Skip to content

Commit

Permalink
Adds further documentation around how Acquia Cli converts strings int…
Browse files Browse the repository at this point in the history
…o UUIDs.
  • Loading branch information
typhonius committed Nov 29, 2017
1 parent ca58aa6 commit a3071d9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ All other parameters are currently provided in the UUID form, including but not
* Team ID
* Organization ID

Commands using the following parameters will be automatically converted by the Acquia Cli tool using the SDK. This is achieved in the `validateUuidHook` method in the `AcquiaCommand` class using a `@hook validate` [annotation](https://github.com/consolidation/annotated-command).
* `$uuid` is converted to the UUID of the application
* `$environment` is converted into an EnvironmentResponse object
* `$environmentFrom` is converted into an EnvironmentResponse object
* `$environmentTo` is converted into an EnvironmentResponse object


## Creating a Phar
A phar archive can be created to run Acquia Cli instead of utilising the entire codebase. Because some of Acquia Cli relies on user configuration of email/password, it is currently most appropriate to allow users to generate their own phar files inclusive of their own configuration.
Expand Down

0 comments on commit a3071d9

Please sign in to comment.