An open API service indexing awesome lists of open source software.

https://github.com/xiaoxiaojx/publish-sftp

One-line command to quickly publish resources to a specified server
https://github.com/xiaoxiaojx/publish-sftp

ftp ftp-client sftp sftp-client

Last synced: 5 months ago
JSON representation

One-line command to quickly publish resources to a specified server

Awesome Lists containing this project

README

          


Logo

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest

One-line command to quickly publish resources to a specified server..



NPM Version
Package License
NPM Downloads

### Usage
> Add sftp.json to the root of the project
```
// ./sftp.json
{
"localPath": "./dist",
"remotePath": "/export/App/xxx",
"protectedRemotePath": "/export/App/xxx",
"connect": {
"host": "xxx.xxx.xxx.xx",
"port": 22,
"username": "root",
"password": "123456"
}
}
```

### Getting started
```
yarn add publish-sftp
```
![image](https://pic4.zhimg.com/80/v2-e403806e29315abb62e339fe555d55f4_1440w.png)
> 复制 localPath 下所有文件到 remotePath/xjx/test, -c 参数为空则是复制到 remotePath, 远程目录不存在会先创建

#### copy
> 复制 localPath 下所有文件到 remotePath 目录下, 如果 xxx 有值则是复制到 `${remotePath}/${xxx}` 目录
```
publish-sftp -c xxx
```

#### remove
> 删除 remotePath 目录, 如果 xxx 有值则是删除 `${remotePath}/${xxx}` 目录
```
publish-sftp -r xxx
```

### Tips
> protectedRemotePath 字段为避免误操作增加,删除等危险操作涉及到该目录会立即终止 ⚠️