{"id":18278764,"url":"https://github.com/terminus-plugin-project/terminus-backup-all-plugin","last_synced_at":"2026-05-17T00:04:19.469Z","repository":{"id":57066864,"uuid":"77422635","full_name":"terminus-plugin-project/terminus-backup-all-plugin","owner":"terminus-plugin-project","description":"Backup All - A Terminus plugin to backup all available Pantheon sites with one command.","archived":false,"fork":false,"pushed_at":"2019-02-23T04:28:52.000Z","size":41,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"2.x","last_synced_at":"2025-04-09T04:41:32.096Z","etag":null,"topics":["backup","composer","pantheon","plugin","terminus","terminus-backup","terminus-plugin"],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/terminus-plugin-project/terminus-backup-all-plugin","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terminus-plugin-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-27T03:23:19.000Z","updated_at":"2024-05-02T14:49:02.000Z","dependencies_parsed_at":"2022-08-24T10:10:46.874Z","dependency_job_id":null,"html_url":"https://github.com/terminus-plugin-project/terminus-backup-all-plugin","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/terminus-plugin-project/terminus-backup-all-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terminus-plugin-project%2Fterminus-backup-all-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terminus-plugin-project%2Fterminus-backup-all-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terminus-plugin-project%2Fterminus-backup-all-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terminus-plugin-project%2Fterminus-backup-all-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terminus-plugin-project","download_url":"https://codeload.github.com/terminus-plugin-project/terminus-backup-all-plugin/tar.gz/refs/heads/2.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terminus-plugin-project%2Fterminus-backup-all-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259831126,"owners_count":22918457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","composer","pantheon","plugin","terminus","terminus-backup","terminus-plugin"],"created_at":"2024-11-05T12:25:59.837Z","updated_at":"2025-10-12T00:04:40.364Z","avatar_url":"https://github.com/terminus-plugin-project.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Terminus Backup All Plugin\n\nVersion 2.x\n\n[![CircleCI](https://circleci.com/gh/terminus-plugin-project/terminus-backup-all-plugin.svg?style=shield)](https://circleci.com/gh/terminus-plugin-project/terminus-backup-all-plugin)\n[![Terminus v2.x Compatible](https://img.shields.io/badge/terminus-v2.x-green.svg)](https://github.com/terminus-plugin-project/terminus-backup-all-plugin/tree/2.x)\n[![Terminus v1.x Compatible](https://img.shields.io/badge/terminus-v1.x-green.svg)](https://github.com/terminus-plugin-project/terminus-backup-all-plugin/tree/1.x)\n[![Terminus v0.x Compatible](https://img.shields.io/badge/terminus-v0.x-green.svg)](https://github.com/terminus-plugin-project/terminus-backup-all-plugin/tree/0.x)\n\nTerminus plugin to backup all available Pantheon sites with one command.\n\n## Usage:\n```console\n$ terminus backup-all:[create|get|list] [--env=\u003cid\u003e] [--element=\u003celement\u003e] [--framework=\u003cframework\u003e] [--skip=\u003citems\u003e] [--date=\u003cYYYY-MM-DD\u003e] [--changes=\u003cchange\u003e] [--team] [--owner=\u003cuser\u003e] [--org=\u003corg\u003e] [--name=\u003cregex\u003e] [--async]\n```\nThe associative arguments are all optional and the same filtering rules as the `terminus site:list` command apply.\n\nThe **--env** option value filters by environment.  Valid values include **dev, test, live** or any valid multidev environment.\n\nThe **--element** option value filters by element.  Valid values include **code, database or files**.\n\nThe **--framework** option value filters by framework.  Valid values include **backdrop, drupal, drupal8 or wordpress**.\n\nThe **--skip** option value is a comma separated list of one or more elements, entire environments or specific site environments to omit from backups.\n\nThe **--date** option value filters by a specified date (or colon separated range) and returns the backups for any date if omitted.\n\nThe **--changes** option is only necessary when the environment is in sftp connection mode and decides how to handle pending filesystem changes.  Valid values include **commit, ignore or skip** and the default is **commit** which will create an automatic commit of any pending filesystem changes before completing the backup.  The difference between **ignore** and **skip** is **ignore** will continue and make the backup anyway *_(without pending filesystem changes)_*, whereas **skip** will not.\n\nThe **--async** option value will process the request asynchronously.\n\n## Examples:\n```console\n$ terminus ball:create\n```\nThis 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.\n```console\n$ terminus ball:create --async\n```\nSame as above but process the request asynchronously.\n```console\n$ terminus ball:create --element=code --changes=ignore --skip=test,my-experiment.dev\n```\nBackup 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`.\n```console\n$ terminus ball:create --framework=drupal,drupal8\n```\nBackup all elements of all environments for all available sites that include the drupal and drupal8 (Drupal 6, 7 and 8) frameworks and perform the backup after committing pending filesystem changes.\n```console\n$ terminus ball:list\n```\nThis is an alias for the `terminus backup-all:list` command and will list the backups of all elements in all available site environments.\n```console\n$ terminus ball:list --env=dev\n```\nList the backups of all elements in the dev environment only of all available sites.\n```console\n$ terminus ball:list --element=code\n```\nList the backups of the code only for all available site environments.\n```console\n$ terminus ball:list --framework=drupal,drupal8\n```\nList the backups of all elements in all environments for all available sites that include the drupal and drupal8 (Drupal 6, 7 and 8) frameworks.\n```console\n$ terminus ball:list --date=YYYY-MM-DD\n```\nList the backups for all available site environments on the specified date.\n```console\n$ terminus ball:list --date=YYYY-MM-DD:YYYY-MM-DD\n```\nSame as above but within the specified colon separated date range.\n```console\n$ terminus ball:list --name=awesome --date=YYYY-MM-DD\n```\nList the backups for all available site environments on the specified date that contain `awesome` in the name.\n```console\n$ terminus ball:get\n```\nThis is an alias for the `terminus backup-all:get` command and will retrieve the latest files backup for all available site environments.\n```console\n$ terminus ball:get --name=awesome\n```\nRetrieve the latest files backup for all available site environments that contain `awesome` in the name.\n```console\n$ terminus ball:get --element=db\n```\nRetrieve the latest database backup for all available site environments.\n```console\n$ terminus ball:get --framework=drupal,drupal8\n```\nRetrieve the latest files backup of all environments for all available sites that include the drupal and drupal8 (Drupal 6, 7 and 8) frameworks.\n```console\n$ terminus ball:get --env=dev --element=code --date=YYYY-MM-DD\n```\nRetrieve the latest code backup of the dev environment only for all available sites on the specified date.\n```console\n$ terminus ball:get --env=dev --element=code --date=YYYY-MM-DD:YYYY-MM-DD\n```\nSame as above but within the specified colon separated date range.\n```console\n$ terminus ball:get --name=awesome --date=YYYY-MM-DD\n```\nRetrieve the latest files backup for all available site environments on the specified date that contain `awesome` in the name.\n\n## Installation:\nFor installation help, see [Extend with Plugins](https://pantheon.io/docs/terminus/plugins/).\n\n```bash\nmkdir -p ~/.terminus/plugins\ncomposer create-project -d ~/.terminus/plugins terminus-plugin-project/terminus-backup-all-plugin:~2\n```\n\n## Testing:\n\nReplace `my-test-site` with the site you want to test:\n```bash\nexport TERMINUS_SITE=my-test-site\ncd ~/.terminus/plugins/terminus-backup-all-plugin\ncomposer install\ncomposer test\n```\n\n## Configuration:\nIf you wish to automate backups, see the core `terminus backup:automatic` command.\n\n## Help:\nRun `terminus help ball:[create|get|list]` for help.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterminus-plugin-project%2Fterminus-backup-all-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterminus-plugin-project%2Fterminus-backup-all-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterminus-plugin-project%2Fterminus-backup-all-plugin/lists"}