History

Oscar Marshall fd105a3ef9 fix(upload): ssh-deploy-on-explicit-save = 1 #7513 changed the expected value of `ssh-deploy-on-explicit-save` to be #an integer, but the default value was still `t`. This commit changes it #to be `1`. Amend: #7513		2024-05-21 17:16:32 +02:00
..
config.el	fix(upload): ssh-deploy-on-explicit-save = 1	2024-05-21 17:16:32 +02:00
packages.el	bump: :tools	2024-05-21 17:15:56 +02:00
README.org	docs(upload): append slash to ssh-deploy-root-local	2024-05-21 17:16:23 +02:00

README.org

:tools upload

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
Troubleshooting
- root-local and root-remote must match
Frequently asked questions
Appendix

Description unfold

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.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO 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 . 1))))

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

TODO 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?

TODO Appendix

󱌣 This module has no appendix yet. Write one?