Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.48 KB

README.md

File metadata and controls

47 lines (30 loc) · 2.48 KB
Raw

Terminus Composer Plugin

CircleCI Actively Maintained

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:

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.