History

Henrik Lissner 037b018cdd feat: add .doommodule files These optional dotfiles indicate the root of a module or module group (:lang), and will later contain module metadata. They will also serve as an alternative to packages.el and doctor.el, and will aide the parts of the v3.0 module API concerned with resolving the current module from a path (`doom-module-from-path`), which currently rely too heavily on parsing path strings. For now, however, they're simply placeholders.		2024-09-14 20:47:39 -04:00
..
.doommodule	feat: add .doommodule files	2024-09-14 20:47:39 -04:00
config.el	fix(upload): ssh-deploy-on-explicit-save = 1	2024-01-27 03:17:57 -05:00
packages.el	bump: :tools	2023-09-12 21:30:56 +02:00
README.org	docs(upload): append slash to ssh-deploy-root-local	2023-11-24 10:54:36 -05: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?