atom-sftp-sync's Introduction

Atom SFTP Sync

This is a fork of Axel Moussard's sftp-deployment.

Spend less time managing file transfers and more time coding. FTP and SFTP support for Atom.io to send and receive files directly in your server.

Features

Workflows

Upload/Download current file
Upload open files (tabs)
Upload/Download selection from Tree View

Compatibility

Supports FTP and SFTP servers
Password SSH support
Works on Windows, OS X and Linux

Integration

Menu entries and command palette control
File-based configuration (JSON)
Colorized output panel with options for automatic hiding

Installation

Search sftp or ftp in the atom package manager
Since the installation is successful, you can generate the configuration file with the command

cmd-shift-p and search mapToRemote
Packages menu -> SFTP Sync -> Map to Remote...
Create your own

Set your ftp/sftp configuration in this file
Use it!

The configuration file MUST always be in the root directory of your project.

Examples of configuration files

SFTP with user/password

{
    "type": "sftp",
    "host": "example.com",
    "user": "username",
    "password": "password",
    "port": "22",
    "remotePath": "/example/path"
}

SFTP protocol with private key

{
    "type": "sftp",
    "host": "example.com",
    "user": "username",
    "port": "22",
    "remotePath": "/example/path",
    "sshKeyFile": "~/.ssh/id_rsa",
    "passphrase": "your_passphrase"
}

The passphrase is optional, only if your key require it.

FTP protocol

{
  "type": "ftp",
  "host": "example.com",
  "username": "username",
  "password": "password",
  "port": "21",
  "remotePath": "/example/path"
}

Acknowledgments

Shout out to Axel Moussard and the Ellipsis Team for the original sftp-deployment plugin! Atom-sftp-sync wouldn't exist without the effort and dedication of the original authors and contributors.

Recommend Projects