Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
uberhacker committed May 6, 2018
2 parents 34d32fe + 331d128 commit a0c5707
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Version 1.x
Terminus plugin to backup all available Pantheon sites with one command.

## Usage:
```
```console
$ terminus backup-all:[create|get|list] [--env=<id>] [--element=<element>] [--skip=<items>] [--date=<YYYY-MM-DD>] [--changes=<change>] [--team] [--owner=<user>] [--org=<org>] [--name=<regex>] [--async]
```
The associative arguments are all optional and the same filtering rules as the `terminus site:list` command apply.
Expand All @@ -27,79 +27,79 @@ The **--changes** option is only necessary when the environment is in sftp conne
The **--async** option value will process the request asynchronously.

## Examples:
```
```console
$ terminus ball:create
```
This is an alias for the `terminus backup-all:create` command and will backup all elements of all environments for all available sites and perform the backup after committing pending filesystem changes.
```
```console
$ terminus ball:create --async
```
Same as above but process the request asynchronously.
```
```console
$ terminus ball:create --element=code --changes=ignore --skip=test,my-experiment.dev
```
Backup the code only of all environments for all available sites and perform the backup without committing pending filesystem changes, skipping all test environments and the specific site environment `my-experiment.dev`.
```
```console
$ terminus ball:list
```
This is an alias for the `terminus backup-all:list` command and will list the backups of all elements in all available site environments.
```
```console
$ terminus ball:list --env=dev
```
List the backups of all elements in the dev environment only of all available sites.
```
```console
$ terminus ball:list --element=code
```
List the backups of the code only for all available site environments.
```
```console
$ terminus ball:list --date=YYYY-MM-DD
```
List the backups for all available site environments on the specified date.
```
```console
$ terminus ball:list --date=YYYY-MM-DD:YYYY-MM-DD
```
Same as above but within the specified colon separated date range.
```
```console
$ terminus ball:list --name=awesome --date=YYYY-MM-DD
```
List the backups for all available site environments on the specified date that contain `awesome` in the name.
```
```console
$ terminus ball:get
```
This is an alias for the `terminus backup-all:get` command and will retrieve the latest files backup for all available site environments.
```
```console
$ terminus ball:get --name=awesome
```
Retrieve the latest files backup for all available site environments that contain `awesome` in the name.
```
```console
$ terminus ball:get --element=db
```
Retrieve the latest database backup for all available site environments.
```
```console
$ terminus ball:get --env=dev --element=code --date=YYYY-MM-DD
```
Retrieve the latest code backup of the dev environment only for all available sites on the specified date.
```
```console
$ terminus ball:get --env=dev --element=code --date=YYYY-MM-DD:YYYY-MM-DD
```
Same as above but within the specified colon separated date range.
```
```console
$ terminus ball:get --name=awesome --date=YYYY-MM-DD
```
Retrieve the latest files backup for all available site environments on the specified date that contain `awesome` in the name.

## Installation:
For installation help, see [Extend with Plugins](https://pantheon.io/docs/terminus/plugins/).

```
```bash
mkdir -p ~/.terminus/plugins
composer create-project -d ~/.terminus/plugins terminus-plugin-project/terminus-backup-all-plugin:~1
```

## Testing:

Replace `my-test-site` with the site you want to test:
```
```bash
export TERMINUS_SITE=my-test-site
cd ~/.terminus/plugins/terminus-backup-all-plugin
composer install
Expand Down

0 comments on commit a0c5707

Please sign in to comment.