https://github.com/ilya-potseluev/sftp-deploy-js

SFTP deployer using ssh2-sftp-client
https://github.com/ilya-potseluev/sftp-deploy-js

deploy deployment sftp sftp-client

Last synced: 19 days ago
JSON representation

SFTP deployer using ssh2-sftp-client

• Host: GitHub
• URL: https://github.com/ilya-potseluev/sftp-deploy-js
• Owner: Ilya-Potseluev
• Created: 2022-05-01T17:44:48.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-28T10:46:53.000Z (about 2 years ago)
• Last Synced: 2024-05-11T09:53:21.357Z (9 months ago)
• Topics: deploy, deployment, sftp, sftp-client
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/sftp-deploy-js
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# sftp-deploy-js

SFTP deployer using [ssh2-sftp-client](https://github.com/theophilusx/ssh2-sftp-client)

## Installation

```js

npm install --save-dev sftp-deploy-js

```

## Example

```javascript

import { fileURLToPath } from 'url';

import path from 'path';

const __dirname = path.dirname(fileURLToPath(import.meta.url));

import Deployer from 'sftp-deploy-js';

const deployer = new Deployer();

const config = {

	host: 'your host',

	port: '22',

	username: 'your username',

	password: 'your password' || null, // if not specified, you can enter in the console

	// other options specified in https://github.com/theophilusx/ssh2-sftp-client#sec-4-2-2

	from: path.join(__dirname, 'dist'), // path on local

	to: '/path/on/server/',

	rmdir: true, // remove or not remove an existing directory on server with files

};

await deployer.init(config); // checks config and asks password

deployer.on('upload', console.log); // copies event from ssh2-sftp-client

let total = await deployer.deploy(); // returns the number of uploaded files

console.log(`Total files: ` + total);

```