npm 包 node-ssh 使用教程

最近在进行前端开发时遇到了需要通过 SSH 连接到远程服务器的情况,而 npm 上提供的 node-ssh 包解决了这个问题。

本文将详细介绍 node-ssh 的使用方法,包括创建 SSH 连接、执行远程命令、上传和下载文件等操作。

安装

在使用 node-ssh 之前,需要安装它。

通过 npm 安装:

--- ------- --------

或者通过 yarn 安装:

---- --- --------

创建 SSH 连接

使用 node-ssh 是要先创建一个 SSH 连接,通过这个连接可以执行各种操作。

通过如下代码创建 SSH 连接:

----- ------- - -------------------

----- --- - --- ---------

-------------
    ----- -------------------
    --------- ----------------
    ----------- ---------------------------
--

其中 your-server-host 是你要连接的远程服务器地址,your-username 是你在该服务器上的用户名,/path/to/your/private/key 是你的私钥文件路径。如果需要密码登录,可以在 connect 方法中传递 password 属性。

执行远程命令

创建了 SSH 连接之后,我们就可以执行远程命令了。

---------------------
    ------------ -- -
        --------------------------
    --
    ------------ -- -
        --------------------
    --

使用 execCommand 方法执行远程命令,接受一个字符串类型的参数,表示要执行的命令。该方法返回一个 Promise 对象,可以通过 then 方法获取命令执行结果和错误信息。

上传和下载文件

在日常开发中,会碰到需要上传或下载文件到远程服务器的情况。node-ssh 也提供了很好的支持。

上传文件:

--------------
    - ------ ---------------------- ------- ---------------------- -
---------- -- -
    ------------------- ---------
--

下载文件:

----------------------------------- ------------------------------ -- -
    --------------------- ---------
--

putFiles 方法接受一个数组类型的参数,数组中每个元素都包含一个 local 和一个 remote 属性,分别表示本地文件路径和远程服务器上要存储的文件路径。getFile 方法接受两个参数,第一个参数是远程文件路径,第二个参数是本地文件路径。

建立 Promise 链式调用

在实际应用中,常常需要执行多个命令和操作。这时候,可以使用 Promise 链式调用的方式,简化代码。

-------------
    ----- -------------------
    --------- ----------------
    ----------- ---------------------------
---------- -- -
    ------ ---------------------
-------------- -- -
    --------------------------
    ------ --------------
        - ------ ---------------------- ------- ---------------------- -
    --
---------- -- -
    ------------------- ---------
    ------ ----------------------------------- ----------------------
---------- -- -
    --------------------- ---------
-------------- -- -
    --------------------
--

将多个操作通过 Promise 链式调用的方式串连起来。

总结

node-ssh 是一个非常实用的 npm 包,可以在前端开发中轻松连接远程服务器,执行远程命令以及上传和下载文件等常见操作。在使用时需要注意配置私钥文件等细节,尤其要注意服务器安全。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/63937


猜你喜欢

  • npm 包 catch-output 使用教程

    引言 在前端开发中,有时我们需要将一些 console 输出的内容记录下来,以便调试或分析应用程序的逻辑。 而 catch-output 正是一个可以将 console 输出的内容捕获并保存到文件中的...

    6 年前
  • NPM 包 glob.js 使用教程

    什么是 glob.js? glob.js 是一个 Node.js 模块,它允许我们以 UNIX shell 风格的模式匹配文件和文件夹。 有关 UNIX shell 风格的模式匹配,可以是以下语句: ...

    6 年前
  • npm 包 fis-scaffold-kernel 使用教程

    概述 fis-scaffold-kernel 是一个用于前端项目初始化的脚手架工具。通过 fis-scaffold-kernel,您可以快速地生成一个基于 fis3 的前端项目架构,并集成了 babe...

    6 年前
  • npm包fis-command-install使用教程

    对于前端开发者来说,使用npm包是一项必备的技能。fis-command-install就是npm包中的一个非常重要的模块,可以帮助我们更方便地安装项目所需的各种依赖。

    6 年前
  • npm 包 fis3-packager-map 使用教程

    简介 fis3-packager-map 是一个极其实用的 npm 包,它为前端开发者提供了一个方便的工具,它可以帮助开发者快速组织和管理前端资源文件。它主要解决的问题是在开发过程中,各种前端文件文件...

    6 年前
  • npm 包 fis-deploy-default 使用教程

    前言 在前端开发过程中,我们通常需要将本地开发的代码上线到线上服务器。为了方便地实现这一过程,一些前端工具库提供了对应的部署插件。其中,fis-deploy-default 就是一款常用的 npm 包...

    6 年前
  • npm 包 fis-command-server 使用教程

    什么是 fis-command-server fis-command-server 是 fis3 的一个插件包,它可以在 fis3 的启动时启动一个 http 服务,支持进程信息查看、发布构建项目等功...

    6 年前
  • npm 包 fis-command-release 使用教程

    首先,我们需要了解一下 npm 包和 fis-command-release 这两个概念。 npm 是 Node.js 的包管理器,用于安装和分发 Node.js 模块。

    6 年前
  • npm 包 fis-prepackager-derived 使用教程

    前言 在前端开发中,我们经常需要使用打包工具来处理我们的项目,并将其打包成静态资源。而在这其中,fis3 是一个不错的选择。它是一个基于前端工程化的构建工具,能够快速、高效地构建前端项目。

    6 年前
  • npm 包 fis-postprocessor-jswrapper 使用教程

    简介 在进行前端开发过程中,有时需要把多个 JavaScript 文件合并成一个文件,方便进行管理和维护。fis-postprocessor-jswrapper 就是一个使用 fis3 打包工具的 n...

    6 年前
  • npm 包 fis-packager-map 使用教程

    前端开发中,我们经常需要将代码进行打包、压缩和部署等操作。而 fis-packager-map 正是一个非常实用的 npm 包,可以帮助我们将静态资源文件进行打包,并生成对应的 map 文件,方便调试...

    6 年前
  • npm 包 fis-preprocessor-components 使用教程

    前言 在前端开发中,我们经常需要将一个页面拆分成很多组件进行开发,而且这些组件往往都是可复用的。如何将这些组件进行管理和打包,就成为了一个很重要的问题。 在这里,我们将介绍一个 npm 包 fis-p...

    6 年前
  • npm 包 fis-kernel 使用教程

    什么是 fis-kernel? fis-kernel 是一个基于 fis3 的前端自动化构建工具,通过对前端资源打包压缩、语法转换、静态资源处理等一系列流程的优化,可以有效提高前端开发效率和项目运行性...

    6 年前
  • npm 包 fis 使用教程

    什么是 npm 包 fis? npm 包 fis 是一个开源的前端构建工具,用于将前端资源进行打包、压缩、合并等操作,同时支持多种开发框架和模块化规范,并提供了丰富的插件和扩展机制。

    6 年前
  • npm 包 fis3-hook-components 使用教程

    前言 fis3 是前端工程化的常用工具,可以帮助前端工程师进行优化、打包等操作。其中 fis3-hook-components 是 fis3 的一个插件,用于自动化加载组件,提高开发效率。

    6 年前
  • npm 包 fis3-deploy-local-deliver 使用教程

    前言 在前端开发中,我们经常需要将静态资源部署到不同的服务器上,这对于我们来说是非常麻烦的。然而,有一个名为 fis3-deploy-local-deliver 的 npm 包可以帮助我们轻松地解决这...

    6 年前
  • npm 包 Fis3-Deploy-Encoding 使用教程

    在前端开发中,我们经常需要把网站的静态资源进行压缩、合并等优化操作,以提高网站的加载速度。而 Fis3 是一个非常优秀的前端构建工具,可以自动完成静态资源打包、压缩、合并等操作。

    6 年前
  • npm 包 fis3-deploy-http-push 使用教程

    前言 fis3-deploy-http-push 是一款非常实用的 npm 包,它可以帮助前端类项目实现自动化部署。通过配置 FTP、SFTP 等协议信息,fis3-deploy-http-push ...

    6 年前
  • npm 包 yog-devtools 使用教程

    前言 在前端开发中,我们会不断的尝试新的框架、工具,不断地寻找能够提高开发效率、优化代码质量的工具。那么今天我们来介绍一个在前端调试和分析中非常有用的 npm 包:yog-devtools。

    6 年前
  • npm 包 fis3-server-node 使用教程

    在前端开发过程中,我们经常需要使用到各种构建工具和服务器,以提高开发效率和优化网站性能。本文将介绍一款基于 Node.js 的静态资源服务器 fis3-server-node,并教你如何使用它进行开发...

    6 年前

相关推荐

    暂无文章