Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
sftp-sync-deploy
Advanced tools
Readme
Sync local files to remote using SFTP.
const { deploy } = require('sftp-sync-deploy');
let config = {
host: 'example.com', // Required.
port: 22, // Optional, Default to 22.
username: 'user', // Required.
password: 'password', // Optional.
privateKey: '/path/to/key.pem', // Optional.
passphrase: 'passphrase', // Optional.
agent: '/path/to/agent.sock', // Optional, path to the ssh-agent socket.
localDir: 'dist', // Required, Absolute or relative to cwd.
remoteDir: '/path/to/dest' // Required, Absolute path only.
};
let options = {
dryRun: false, // Enable dry-run mode. Default to false
exclude: [ // exclude patterns (glob)
'node_modules',
'src/**/*.spec.ts'
],
excludeMode: 'remove', // Behavior for excluded files ('remove' or 'ignore'), Default to 'remove'.
forceUpload: false // Force uploading all files, Default to false(upload only newer files).
};
deploy(config, options).then(() => {
console.log('success!');
}).catch(err => {
console.error('error! ', err);
})
import { deploy, SftpSyncConfig, SftpSyncOptions } from 'sftp-sync-deploy';
let config: SftpSyncConfig = {...};
let options: SftpSyncOptions = {...};
deploy(config, options);
deploy(config, {dryRun: true});
Outputs the tasks to be done for each file in following format. Any changes of the files will not be performed.
[ (local file status) | (remote file status) ] (file path)
-> (task)
# Local is a file (upload the file)
[ F | F ] index.html
-> upload
# Local is a directory (sync recursively)
[ D | D ] lib
-> sync
# Excluded. (do nothing)
[ X | ] node_modules
-> ignore
# Remote exists and local doesn't (remove the remote file or directory)
[ | F ] index.html.bak
-> remove remote
# Remote exists and local is excluded (operation depends on excludeMode option)
[ X | D ] .bin
-> remove remote # if excludeMode is 'remove'
-> ignore # if excludeMode is 'ignore'
# Local and remote have the same name but different types (remove remote then upload local)
[ F | D ] test
-> remove remote and upload
# Permission error on a remote server (ignored)
[ F | ! ] secret.txt
-> denied
FAQs
Sync local files to remote using SFTP.
The npm package sftp-sync-deploy receives a total of 4,305 weekly downloads. As such, sftp-sync-deploy popularity was classified as popular.
We found that sftp-sync-deploy demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.