README.md in acquia_toolbelt-1.5.1 vs README.md in acquia_toolbelt-2.0.0
- old
+ new
@@ -13,48 +13,66 @@
```
Once installed, the toolbelt is accessible via invoking `acquia` within the command line.
## Usage
+You can see all available commands by running `acquia help`. Additonally, more information on each command is available via `acquia [COMMAND] help`.
-You can see all available commands by running `acquia` without any commands or parameters. Additonally, more information on each command is available via `acquia help [COMMAND]`.
-
```
-$ acquia
+$ acquia help
+Type 'acquia [COMMAND] help' for more details on subcommands or to show example usage.
+
Commands:
- acquia add-database <subscription> <database> # Create a new database instance.
- acquia add-domain <subscription> <environment> <domain> # Add a domain to an environment.
- acquia copy-database <subscription> <database> <source> <destination> # Copy a database one from environment to another.
- acquia copy-files <subscription> <source> <destination> # Copy files from one environment to another.
- acquia delete-database <subscription> <database> # Remove all instances of a database.
- acquia delete-domain <subscription> <environment> <domain> # Delete a domain from an environment.
- acquia delete-ssh-user <subscription> <id> # Delete a SSH key from the subscription.
- acquia delete-svn-user <subscription> <userid> # Delete a SVN user.
- acquia deploy-code <subscription> <environment> <release> # Deploy a specific VCS branch or tag to an environment.
- acquia help [COMMAND] # Describe available commands or one specific command
- acquia list-database-backups <subscription> <environment> <database> # Get all backups for a database instance.
- acquia list-databases <subscription> # See information about the databases within a subscription.
- acquia list-domains <subscription> # Show all available domains for a subscription.
- acquia list-environments <subscription> # Provide an overview of the environments in your subscription.
- acquia list-servers <subscription> # Get a list of servers specifications for an environment.
- acquia list-ssh-users <subscription> # Find out who has access and SSH keys.
- acquia list-subscriptions # Find all subscriptions that you have access to.
- acquia list-svn-users <subscription> # See all the SVN users on a subscription.
- acquia list-tasks <subscription> # Display tasks associated with a subscription.
- acquia login # Login to your Acquia account.
- acquia purge-domain <subscription> <environment> # Clear the web cache of an environment or domain.
- acquia restore-database-backup <subscription> <environment> <database> <backup_id> # Restore a database backup.
+ acquia auth
+ acquia databases
+ acquia deploy
+ acquia domains
+ acquia environments
+ acquia files
+ acquia servers
+ acquia sites
+ acquia ssh
+ acquia svn
+ acquia tasks
+
+Options:
+ -s, [--subscription=SUBSCRIPTION] # Name of a subscription you would like to target.
+ -e, [--environment=ENVIRONMENT] # Environment to target for commands.
+ -v, [--verbose] # Increase the verbose output from the commands.
```
+#### Example commands
+
+Without parameters
+
+```
+$ acquia database:list
+
+> mydb
+> mydb2
+```
+
+With parameters
+
+```
+$ acquia database:list -e dev -d mydb
+
+> Username: exampledb
+> Password: h5hKN4v2nc*1nd
+> Host: staging-1234
+> DB cluster: 1111
+> Instance name: mydb8717
+```
+
## Getting started
-Before you can start using any commands, you need to first run `acquia login`. This will write your login details to a local netrc file so that you won't be prompted for login details every time a request is made. After that, the sky is the limit!
+Before you can start using any commands, you need to first run `acquia auth:login`. This will write your login details to a local netrc file so that you won't be prompted for login details every time a request is made. After that, the sky is the limit!
## FAQ
-**Q:** Is there support for proxies and corporate firewalls?
+**Q: Is there support for proxies and corporate firewalls? **
**A:** By god yes. Proxies and corporate firewalls are the bane of my existence so there was no way this toolbelt _wasn't_ going to support it. To use a proxy, all you need to do is set your HTTPS_PROXY environment variable to the required value. Example:
```bash
$ export HTTPS_PROXY="http://myproxy.url.internal:1234"
@@ -63,9 +81,19 @@
Then to check the value was correctly set:
```bash
$ echo $HTTPS_PROXY
$ http://myproxy.url.internal:1234
+```
+
+**Q: Is there somewhere I can see all the commands with required parameters? **
+
+**A:** Yep. Check out the [commands listing](https://github.com/jacobbednarz/acquia-toolbelt/wiki/Commands) in the [wiki](https://github.com/jacobbednarz/acquia-toolbelt/wiki).
+
+## Running tests
+
+```
+bundle exec ruby spec_helper.rb
```
## Contributing
1. Fork it