1.10.3 • Published 2 years ago

ssh-sftp v1.10.3

Weekly downloads
20
License
MIT
Repository
-
Last release
2 years ago

ssh-sftp

简单易用的 SFTP 工具,可以上传/忽略/删除远程的文件

安装

# 全局
npm i ssh-sftp -g

# 局部
npm i ssh-sftp -D

使用

  1. 首先初始化一份配置文件

npx ssh-sftp init

  1. 将生成的.sftprc.json文件里的信息填写完整

  2. 添加脚本到 package.json

{
  "scripts": {
    "deploy": "ssh-sftp",
    "ls-deploy-files": "ssh-sftp ls"
  }
}

建议在部署前使用npx ssh-sftp ls查看哪些文件会被上传或删除

字段说明

.sftprc.json

字段名类型描述
localPathstring
remotePathstring
connectOptionsConnectOptions登录信息
ignorestring[]忽略localPath中的部分文件,glob类型
cleanRemoteFilesboolean \| string[]清空远程文件夹,或按glob匹配清空远程部分文件
securityLockboolean安全锁,默认开启
keepAliveboolean保持连接
noWarnboolean禁止提示

connectOptions

字段名类型描述
hoststring
portnumber
usernamestring
passwordstring

securityLock

安全锁 默认开启,会校验项目名称与远程地址是否匹配防止误传,关闭后忽略验证

Commands

ssh-sftp init

初始化生成配置文件 .sftprc.json

ssh-sftp ls

列出所有需要上传/删除/忽略的文件

ssh-sftp ls -u 单独列出所有需要上传的文件

ssh-sftp ls -d 单独列出所有需要删除的文件

ssh-sftp ls -i 单独列出所有忽略的文件

1.10.3

2 years ago

1.10.2

3 years ago

1.10.1

3 years ago

1.10.0

3 years ago

1.9.2

3 years ago

1.9.1

3 years ago

1.9.0

3 years ago

1.8.1

3 years ago

1.8.0

3 years ago

1.7.1

3 years ago

1.7.0

3 years ago

1.6.0

3 years ago

1.5.0

3 years ago

1.4.0

3 years ago

1.3.0

3 years ago

1.2.1

3 years ago

1.2.0

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.0.0

3 years ago