Emacs SSH Deploy 使用教程

1. 项目介绍

emacs-ssh-deploy 是一个为 Emacs 编辑器设计的插件，它通过 Tramp（一种可以在 Emacs 中访问远程文件的机制）使得部署本地文件和目录到远程主机变得简单。该插件支持多种协议，如 SSH、SFTP、FTP 等，并提供了丰富的功能，如自动或手动上传下载、远程文件变化检测、远程终端和数据库会话等。

2. 项目快速启动

首先，确保你已经安装了 Emacs 编辑器，并且你的系统支持 Tramp。

安装

你可以通过以下两种方式安装 emacs-ssh-deploy：

1. 将项目克隆到本地：

   git clone https://github.com/cjohansson/emacs-ssh-deploy.git ~/.emacs.d/ssh-deploy
   

2. 通过 Emacs 的包管理器 package.el 安装：

   • 打开 Emacs，运行 M-x list-packages 或 M-x package-install。
   • 输入 ssh-deploy 并按回车进行安装。

配置

在项目根目录下创建一个名为 .dir-locals.el 的文件来配置你的部署设置。以下是一个配置示例：

((nil
  (
   (ssh-deploy-root-local . "/Users/username/Web/MySite/")
   (ssh-deploy-root-remote . "/ssh:[e-mail]:/var/www/MySite/")
   (ssh-deploy-on-explicit-save . 1)
   (ssh-deploy-remote-sql-database . "myuser")
   (ssh-deploy-remote-sql-password . "mypassword")
   (ssh-deploy-remote-sql-user . "myuser")
   )))

根据你的需求，你可能需要配置其他变量。

使用

配置完成后，你可以通过以下命令开始部署：

M-x ssh-deploy

3. 应用案例和最佳实践

自动部署

你可以在保存文件时自动上传到远程服务器。为了实现这一点，你需要在 .dir-locals.el 文件中设置 (ssh-deploy-on-explicit-save . 1)。

定制部署脚本

如果你需要在部署时运行特定的脚本，你可以定义一个自定义的 lambda 函数，并在配置中设置 (ssh-deploy-script . 'your-custom-function)。

(defun your-custom-function ()
  (let ((default-directory ssh-deploy-root-remote))
    (shell-command "bash compile.sh")))

4. 典型生态项目

在 emacs-ssh-deploy 的生态中，你可以找到许多与之配合使用的插件和工具，例如：

• tramp: 用于访问远程文件。
• async.el: 提供异步操作支持。
• make-thread: 用于创建线程。

使用这些工具，你可以进一步扩展 emacs-ssh-deploy 的功能和自动化部署流程。