https://github.com/terminus-plugin-project/terminus-site-mount-plugin

Site Mount - A Terminus plugin to mount Pantheon sites.
https://github.com/terminus-plugin-project/terminus-site-mount-plugin

composer mount pantheon plugin site-mount terminus terminus-plugin

Last synced: 6 days ago
JSON representation

Site Mount - A Terminus plugin to mount Pantheon sites.

• Host: GitHub
• URL: https://github.com/terminus-plugin-project/terminus-site-mount-plugin
• Owner: terminus-plugin-project
• License: mit
• Created: 2017-01-21T17:00:56.000Z (over 7 years ago)
• Default Branch: 2.x
• Last Pushed: 2022-07-28T15:32:15.000Z (about 2 years ago)
• Last Synced: 2024-08-27T22:36:20.662Z (about 1 month ago)
• Topics: composer, mount, pantheon, plugin, site-mount, terminus, terminus-plugin
• Language: PHP
• Homepage: https://packagist.org/packages/terminus-plugin-project/terminus-site-mount-plugin
• Size: 17.6 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Terminus Site Mount Plugin

[![CircleCI](https://circleci.com/gh/terminus-plugin-project/terminus-site-mount-plugin.svg?style=shield)](https://circleci.com/gh/terminus-plugin-project/terminus-site-mount-plugin)

[![Terminus v2.x Compatible](https://img.shields.io/badge/terminus-v2.x-green.svg)](https://github.com/terminus-plugin-project/terminus-site-mount-plugin/tree/2.x)

[![Terminus v1.x Compatible](https://img.shields.io/badge/terminus-v1.x-green.svg)](https://github.com/terminus-plugin-project/terminus-site-mount-plugin/tree/1.x)

Terminus plugin to mount [Pantheon](https://pantheon.io/) site environments.

## Usage:

```

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

```

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=` 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=` 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=]

```

Unmount the site environment awesome-site.dev.

```

terminus unmount awesome-site.dev [--dir=]

```

Learn more about [Terminus](https://pantheon.io/docs/terminus/) and [Terminus Plugins](https://pantheon.io/docs/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](https://github.com/osxfuse/osxfuse/releases).

- 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:

- Download and install [SFTP Net Drive 2017](http://www.sftpnetdrive.com/products/NDXCA/download).

## Installation:

For installation help, see [Extend with Plugins](https://pantheon.io/docs/terminus/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.