Skip to content

Commit

Permalink
Adds in more appropriate examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
typhonius committed Mar 21, 2020
1 parent 332d428 commit d68bcdd
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ To generate an API access token, login to [https://cloud.acquia.com](https://clo
* The token has been generated, copy the api key and api secret to a secure place. Make sure you record it now: you will not be able to retrieve this access token's secret again.

## Automatic installation/setup
1. Run `./bin/acquiacli setup` (or `./vendor/bin/acquiacli setup` when used as a dependency in another project) which will ask for your credentials and automatically create this file.
1. Run `./bin/acquiacli drush:aliases` to download your available Drush aliases. Follow the instructions output by the command to install them.
1. Run `acquiacli setup` (or `./vendor/bin/acquiacli setup` when used as a dependency in another project) which will ask for your credentials and automatically create this file.
1. Run `acquiacli drush:aliases` to download your available Drush aliases. Follow the instructions output by the command to install them.

## Manual installation/setup
Alternatively, follow the below steps for a manual installation.
Expand All @@ -38,7 +38,7 @@ Acquia Cli will load configuration in the following order with each step overrid
1. Finally, if it exists, an `acquiacli.yml` file in the project root will be loaded.
1. Environment variables take overall precedence for the key and secret, however other config won't be overridden.

The global and per project files may be deleted (manually) and recreated with `./bin/acquiacli setup` whenever a user wishes to do so.
The global and per project files may be deleted (manually) and recreated with `acquiacli setup` whenever a user wishes to do so.

Options may be manually set within the relevant `acquiacli.yml` file to change the following parameters under the `extraconfig` key:

Expand All @@ -60,34 +60,34 @@ Environmment variables can be used to store and provide the API key and secret.
Some of the following commands have aliases for simplicity e.g. `environment:info` has the alias of `e:i`.
````
# Show which applications you have access to.
./bin/acquiacli application:list
acquiacli application:list
# Show detailed information about servers in the prod environment (assuming sitename of prod:acquia obtained from site:list command)
./bin/acquiacli environment:info prod:acquia prod
acquiacli environment:info prod:acquia prod
# Copy the files and db from alpha to dev for testing new code
./bin/acquiacli preprod:prepare prod:acquia alpha dev
acquiacli deploy:prepare prod:acquia alpha dev
# Deploy the develop-build branch to the test environment and run all config update steps.
./bin/acquiacli preprod:deploy prod:acquia test develop-build
# Deploy the develop-build branch to the test environment.
acquiacli code:switch prod:acquia test develop-build
# Deploy the release-1.2.3 branch/tag to the production environment and run all config update steps without prompting the user to confirm.
./bin/acquiacli prod:deploy prod:acquia release-1.2.3 --yes
acquiacli prod:deploy prod:acquia release-1.2.3 --yes
# Get a list of organizations you have access to and display organization UUIDs.
./bin/acquiacli organization:list
acquiacli organization:list
# Add a new team to an organization.
./bin/acquiacli team:create f5626a0a-5ed8-4868-b7aa-c5e91de666b5 'External Contractors'
acquiacli team:create 'My Team Name' 'External Contractors'
# Add a new role to an organization (Use permissions:list to get available permissions for the new role).
./bin/acquiacli role:add f5626a0a-5ed8-4868-b7aa-c5e91de666b5 'Contractors' 'move file to non-prod,move file from prod,download db backup non-prod,download logs non-prod,deploy to non-prod'
acquiacli role:add 'My Team Name' 'Contractors' 'move file to non-prod,move file from prod,download db backup non-prod,download logs non-prod,deploy to non-prod'
# Associate a team with an application within the organization (Use organization:teams to get team UUIDs).
./bin/acquiacli team:addapp prod:acquia d2693c6e-58e7-47e5-8867-e2db88c71b8c
acquiacli team:addapp prod:acquia d2693c6e-58e7-47e5-8867-e2db88c71b8c
# Add a user to a team and assign roles (Use role:list to obtain the role UUIDs).
./bin/acquiacli team:invite d2693c6e-58e7-47e5-8867-e2db88c71b8c '[email protected]' f0b89594-0fc5-4609-935f-1f18c313c6c7
acquiacli team:invite d2693c6e-58e7-47e5-8867-e2db88c71b8c '[email protected]' f0b89594-0fc5-4609-935f-1f18c313c6c7
````

Expand All @@ -108,7 +108,7 @@ Acquia uses the concept of a 'realm' to differentiate between customers on the t

If no hosting realm is provided, prod is used by default. This can be overridden in the command by specifying a realm e.g. `--realm=devcloud`

Both the UUID and the hosting ID (with realm) for your applications may be discovered by running `./bin/acquiacli application:list`
Both the UUID and the hosting ID (with realm) for your applications may be discovered by running `acquiacli application:list`

*Other parameters*
Environment parameters take the label name of the environment e.g. dev
Expand Down

0 comments on commit d68bcdd

Please sign in to comment.