pantheon-systems/terminus-rsync-plugin

Rsync - Terminus Plugin that provides a quick shortcut for rsync-ing files to and from a Pantheon site.

1.2.0 2025-05-01 23:54 UTC

MIT

README

Terminus Plugin that provides a quick shortcut for rsync-ing files to and from a Pantheon sites.

Learn more about Terminus and Terminus Plugins at: https://pantheon.io/docs/terminus/plugins/

Configuration

This plugin requires no configuration to use.

Examples

Copy the files directory of the dev environment of the Pantheon site my_site into a directory named files in the current working directory:

terminus rsync my_site.dev:files .

Copy everything in the files directory of the dev environment of the Pantheon site my_site into a folder called assets in the current working directory, omitting the files directory itself:

terminus rsync my_site.dev:files/ ./assets

Copy everything in the folder assets in the current working directory into a folder called assets in the files directory of the dev environment of the Pantheon site my_site.

terminus rsync ./assets my_site.dev:files

Limitations

Either the source or the destination must be a local file or directory; both cannot be remote.

Installation

To install this plugin using Terminus 3:

terminus self:plugin:install terminus-rsync-plugin

On older versions of Terminus:

mkdir -p ~/.terminus/plugins
composer create-project --no-dev -d ~/.terminus/plugins pantheon-systems/terminus-rsync-plugin

For help installing, see Manage Plugins.

Help

Use terminus help remote:rsync to get help on this command.