{"id":23980854,"url":"https://github.com/fourkitchens/pantheon-tools","last_synced_at":"2025-04-14T04:34:14.793Z","repository":{"id":47076512,"uuid":"91105891","full_name":"fourkitchens/pantheon-tools","owner":"fourkitchens","description":"Tools to run actions against a Pantheon site","archived":false,"fork":false,"pushed_at":"2023-10-27T16:48:58.000Z","size":181,"stargazers_count":16,"open_issues_count":9,"forks_count":3,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-03-27T18:22:27.839Z","etag":null,"topics":["pantheon","terminus"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fourkitchens.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-12T15:37:46.000Z","updated_at":"2023-08-04T22:26:29.000Z","dependencies_parsed_at":"2023-01-28T15:45:36.325Z","dependency_job_id":"4f0a0ae1-a8ce-4de7-85ff-38ba6bf97717","html_url":"https://github.com/fourkitchens/pantheon-tools","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fpantheon-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fpantheon-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fpantheon-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fpantheon-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fourkitchens","download_url":"https://codeload.github.com/fourkitchens/pantheon-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248823130,"owners_count":21167193,"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":["pantheon","terminus"],"created_at":"2025-01-07T10:18:59.461Z","updated_at":"2025-04-14T04:34:14.759Z","avatar_url":"https://github.com/fourkitchens.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pantheon-tools\nTools to improve your development workflow on Pantheon sites including:\n* Tips to make your workflow smoother/faster/less-risky.\n* automating important steps that are easy to forget.\n\nThis includes things like:\n* Sort out configuration problems before you move on to the next step.\n* Create a backup before deploying.\n* Merge the main/master branch into a multidev before going the other direction.\n* Pause a deployment if there's undeployed code in the next environment. \n* General standardization around development process.\n* etc.\n\n## Pre-requisites\n1. Install [Terminus](https://github.com/pantheon-systems/terminus).\n2. `terminus auth:login` to store an access token.\n3. Upload your SSH key to the Pantheon dashboard.\n4. Add Terminus to your Path.  For example, if Terminus is installed at `~/.composer/vendor/bin/terminus` then you need to add `~/.composer/vendor/bin` to your path.\n5. Use Git to checkout this pantheon-tools repository, maybe to the same place you store your other code projects.  \n6. Add the directory containing pantheon-tools to your Path.\n\n### How to add something to your path\n  E.g.\n\n```\nexport PATH=\"$PATH:$HOME/.composer/vendor/bin\"\nexport PATH=\"$PATH:$HOME/path/to/pantheon-tools\"\n```\n\nDepending on your system, you must add the above paths to `~/.profile`, `~/.bash_profile`, or `~/.zshrc`.\n\nNote that an alias will not work.\n\n## Usage \n1. This may be getting a lot of updates, so first ensure that you have the latest version.\n```\ncd /path/to/the/pantheon-tools\ngit pull\n```\n2. The scripts are totally interactive.  Just run them.  E.g.:\n```\npantheon-security-update\n```\n\nThe script will ask you questions along the way (and give you hints when there's ways to add arguments to make things faster).\n\n## Scripts (Categories)\n\n### Deploy\n| Command | Description |\n|--|--|\n| `pantheon-quick-deploy` | Quickly deploy something from dev-\u003etest-\u003elive |\n| `pantheon-commit-and-quick-deploy` | Commit any local changes and then deploy them |\n| `pantheon-deploy` | Deploy dev-\u003etest or test-\u003elive |\n\n### Report\n| Command | Description |\n|--|--|\n| `pantheon-drupal-status-report` | Report a summary of the Status Report for every Drupal site |\n| `pantheon-sites-report` | Get a metric about all sites (e.g. PHP version, or Upstream) |\n| `pantheon-module-report` | Get a list of which sites use which version of a module |\n\n### Update\n| Command | Description |\n|--|--|\n| `pantheon-security-update` | Run security updates on a Pantheon site by first creating a new multi-dev environment |\n\n### Database\n| Command | Description |\n|--|--|\n| `pantheon-db-dump` | Dump a database from any Pantheon site.  Even VIP clients that require an SSH tunnel to connect to the database |\n| `pantheon-db-cli` | Connect to the database of any Pantheon site.  Even VIP clients that require an SSH tunnel to connect to the database |\n\n### Environment\n| Command | Description |\n|--|--|\n| `pantheon-multidev-create` | Create a new multi-dev environment |\n| `pantheon-multidev-merge` | Merge a multi-dev environment into master (the dev environment) |\n| `pantheon-move-domains` | Move custom domains from one site to another |\n\n### Accounts\n| Command | Description |\n|--|--|\n| `pantheon-sites-accounts-rename` | Iterate over all a given list of sites and rename usernames/email addresses |\n| `pantheon-offboard` | Offboard a staff member from your organization |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourkitchens%2Fpantheon-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffourkitchens%2Fpantheon-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourkitchens%2Fpantheon-tools/lists"}