pantheon-systems / terminus-composer-plugin
Composer - A Terminus plugin for running Composer commands on a Pantheon site
Installs: 81 928
Dependents: 0
Suggesters: 0
Security: 0
Stars: 15
Watchers: 12
Forks: 9
Open Issues: 8
Language:Shell
Type:terminus-plugin
This package is auto-updated.
Last update: 2024-10-11 01:11:11 UTC
README
Terminus Plugin to run Composer commands on Pantheon sites.
Adds a command 'composer' to Terminus 1.x, 2.x or 3.x which you can use just like 'drush' or 'wp'.
This project is a simplified version of the original Terminus Composer Plugin by Brian Thompson.
Configuration
This plugin should only be used with sites that are managed by Composer. The recommended upstreams are:
This plugin may also be used with "Build Tools" and "No CI Workflow" sites that were started with one of the following template projects:
- WordPress: Advanced WordPress on Pantheon
- Drupal 8: Example Drops-8 Composer
- Drupal 7: Example Drops-7 Composer
Using Composer to manage standard sites on Pantheon not started with these upstreams (or a similar variant thereof) is not recommended. Using with Drupal 8.8 on the drops-8 will produce a working site, but will make future dashboard updates difficult. Using with sites based on the Standard non-Composer Pantheon WordPress upstream, or Drupal versions prior to 8.8 is likely to break the site.
Examples
terminus composer my-script
terminus composer my-site.dev -- config repositories.drupal composer https://packages.drupal.org/8
terminus composer my-site.dev -- require drupal/media
terminus composer my-site.dev -- update
Installation
Installing via Terminus 3
terminus self:plugin:install pantheon-systems/terminus-composer-plugin
On older versions of Terminus:
mkdir -p ~/.terminus/plugins
composer create-project --no-dev -d ~/.terminus/plugins pantheon-systems/terminus-composer-plugin:~1
Help
Run terminus help composer
for help.