Skip to content

terminus-plugin-project/terminus-site-mount-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Terminus Site Mount Plugin

CircleCI Terminus v2.x Compatible Terminus v1.x Compatible

Terminus plugin to mount Pantheon site environments.

Usage:

terminus [site:]mount|[site:]u(n)mount site-name.env [--dir=<directory> --drive=<drive letter>]

By default, the site environment will be mounted in $HOME/site-name.env (Linux / Mac only).

If you want to mount in a different directory, use the --dir=<directory> option.

Keep in mind, if you mount in a different directory, you will also need to specify the same --dir option when unmounting.

The --drive=<drive letter> option is only necessary on Windows. The values can be 'first', 'last' or any available drive letter.

The default is --drive=first which means the first available drive letter.

Examples:

Mount the site environment awesome-site.dev.

terminus mount awesome-site.dev [--dir=<directory>]

Unmount the site environment awesome-site.dev.

terminus unmount awesome-site.dev [--dir=<directory>]

Learn more about Terminus and Terminus Plugins.

Prerequisites:

Executable mount, umount and sshfs commands must exist (Linux / Mac only).

Mac OSX:

  • Download and install the latest release of osxfuse-x.x.x.dmg.
  • Install sshfs via brew install sshfs

Linux:

  • Debian-based (Debian, Linux Mint, Ubuntu and derivatives): sudo apt-get update && sudo apt-get install sshfs
  • RedHat-based (RedHat, Fedora, CentOS and derivatives): sudo yum install sshfs

Windows:

Installation:

For installation help, see Extend with Plugins.

mkdir -p ~/.terminus/plugins
composer create-project -d ~/.terminus/plugins terminus-plugin-project/terminus-site-mount-plugin:~2

Configuration:

This plugin requires no configuration to use.

Testing:

Replace my-test-site with the site you want to test:

export TERMINUS_SITE=my-test-site
cd ~/.terminus/plugins/terminus-site-mount-plugin
composer install
composer test

Help:

Run terminus help site:mount for help.