terminus-plugin-project/terminus-filer-plugin

Filer - A Terminus plugin for SFTP Connections

v3.0.0 2024-02-15 17:57 UTC

This package is auto-updated.

Last update: 2024-10-15 19:23:54 UTC


README

Terminus v2.x Compatible Terminus v1.x Compatible Terminus v0.x Compatible

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 (Mac only)

Cyberduck (Mac and Windows)

Filezilla (Mac, Linux and Windows)

BitKinex (Windows only)

WinSCP (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.

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.