Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 2.59 KB

README.org

File metadata and controls

79 lines (60 loc) · 2.59 KB

:tools upload

Description

Uses ssh-deploy to map a local folder to a remote one.

From the ssh-deploy README:

The ssh-deploy plug-in for Emacs makes it possible to effortlessly deploy local files and directories to remote hosts via Tramp (including but not limited to SSH, SFTP, FTP). It tries to provide functions that can be easily used by custom scripts.

The idea for this plug-in was to mimic the behavior of PhpStorm deployment functionality.

Maintainers

  • @hlissner

Become a maintainer?

Module flags

This module has no flags.

Packages

  • doom-package:ssh-deploy

Hacks

No hacks documented for this module.

Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

Usage

🔨 This module’s usage documentation is incomplete. Complete it?

Uses ssh-deploy to map a local folder to a remote one. Set ssh-deploy-root-remote and ssh-deploy-root-local in a .dir-locals.el file to establish this mapping. E.g.

((nil . ((ssh-deploy-root-local . "/local/path/to/project")
         (ssh-deploy-root-remote . "/ssh:user@server:/remote/project/")
         (ssh-deploy-on-explicit-save . t))))

📌 ssh-deploy-root-local is optional, and will resort to doom-project-root if unspecified.

Configuration

🔨 This module’s configuration documentation is incomplete. Complete it?

Check out Deployment configuration examples for some ideas of what’s possible.

Troubleshooting

root-local and root-remote must match

The final directory names much match:

((nil . ((ssh-deploy-root-local . "/local/path/to/example-project")
         (ssh-deploy-root-remote . "/ssh:user@server:/remote/example-project/")

Frequently asked questions

This module has no FAQs yet. Ask one?

Appendix

🔨 This module has no appendix yet. Write one?