https://github.com/terminus-plugin-project/terminus-filer-plugin
Filer - A Terminus plugin for SFTP Connections
https://github.com/terminus-plugin-project/terminus-filer-plugin
Last synced: about 1 year ago
JSON representation
Filer - A Terminus plugin for SFTP Connections
- Host: GitHub
- URL: https://github.com/terminus-plugin-project/terminus-filer-plugin
- Owner: terminus-plugin-project
- Created: 2017-01-06T03:50:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-24T21:09:20.000Z (over 1 year ago)
- Last Synced: 2025-03-20T22:22:54.461Z (about 1 year ago)
- Language: PHP
- Size: 20.5 KB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Terminus Filer Plugin
[](https://github.com/terminus-plugin-project/terminus-filer-plugin/tree/2.x)
[](https://github.com/terminus-plugin-project/terminus-filer-plugin/tree/1.x)
[](https://github.com/terminus-plugin-project/terminus-filer-plugin/tree/0.x)
Terminus plugin to open Pantheon sites using an SFTP client.
Adds a sub-command to 'site' which is called 'filer'. This opens a site in your favorite SFTP client.
## Supported SFTP Apps
[Transmit](https://panic.com/transmit/) (Mac only)
[Cyberduck](https://cyberduck.io/) (Mac and Windows)
[Filezilla](https://filezilla-project.org/) (Mac, Linux and Windows)
[BitKinex](http://www.bitkinex.com/) (Windows only)
[WinSCP](https://winscp.net/) (Windows only)
**SFTP** (Mac and Linux)
## Examples
### Reference Application Name
`$ terminus filer companysite-33.dev --app=transmit`
### Reference Application Bundle Name
`$ terminus filer companysite-33.dev --bundle=com.panic.transmit`
### Shortcut for Panic's Transmit
`$ terminus transmit companysite-33.dev`
`$ terminus panic companysite-33.dev`
### Shortcut for Cyberduck
`$ terminus cyberduck companysite-33.dev`
`$ terminus duck companysite-33.dev`
### Shortcut for FileZilla
`$ terminus filezilla companysite-33.dev`
`$ terminus zilla companysite-33.dev`
### Shortcut for BitKinex
`$ terminus bitkinex companysite-33.dev`
`$ terminus bit companysite-33.dev`
### Shortcut for WinSCP
`$ terminus winscp companysite-33.dev`
`$ terminus scp companysite-33.dev`
### Shortcut for SFTP
`$ terminus sftp companysite-33.dev`
## Installation
To install this plugin place it in `~/.terminus/plugins/`.
On Mac OS/Linux:
```
mkdir -p ~/.terminus/plugins
composer create-project -d ~/.terminus/plugins terminus-plugin-project/terminus-filer-plugin:~2
```
For additional help installing, see [Terminus' Plugins](https://pantheon.io/docs/terminus/plugins/).
## Windows
Enviroment variables are available for Windows SFTP clients installed outside the standard `Program Files` directory:
```
BitKinex - TERMINUS_FILER_BITKINEX_LOC
Cyberduck - TERMINUS_FILER_CYBERDUCK_LOC
FileZilla - TERMINUS_FILER_FILEZILLA_LOC
WinSCP - TERMINUS_FILER_WINSCP_LOC
SFTP - TERMINUS_FILER_SFTP_LOC
```
Make sure to include the full path to the executable (including the executable itself).
Example: `TEMINUS_FILER_BITKINEX_LOC="C:\BitKinex\bitkinex.exe"`
See http://www.computerhope.com/issues/ch000549.htm for information on how to set environment variables in Windows.
## Help
Run `terminus help filer` for help.