
Security News
Crates.io Implements Trusted Publishing Support
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
sftp-client-promise
Advanced tools
a SFTP client for node.js, a wrapper for ssh2
npm install sftp-client-promise
let Client = require('sftp-client-promise');
let conn = new Client();
conn.connect({
host: '127.0.0.1',
port: '8080',
username: 'username',
password: '******'
}).then(() => {
return conn.sftp('readdir', {path: '/pathname'});
}).then((data) => {
console.log(data, 'the data info');
}).catch((err) => {
console.log(err, 'catch error');
conn.end();
});
the connection to server config pls see ssh2 client event.
list of methods: all the methods will return a Promise;
read a directory
conn.sftp('readdir', {path: remoteFilePath})
directory info:
type: // file type(-, d, l)
name: // file name
size: // file size
modifyTime: // file timestamp of modified time
accessTime: // file timestamp of access time
rights: {
user:
group:
other:
},
owner: // user ID
group: // group ID
return true if the path(file or directory) exists, false otherwise.
conn.sftp('exists', {path: remotePath})
download file from remote server
conn.sftp('createReadStream', {
path: remoteFilePath,
stream: localWriteStream,
option: option
})
for example:
conn.sftp('createReadStream', {
path: '/home/temp.gz',
stream: fs.createWriteStream('./local/temp.gz')
})
upload file from local, data(stream | buffer | string)
conn.sftp('createWriteStream', {
path: remoteFilePath,
data: stream | buffer | string,
option: option
})
for example:
conn.sftp('createWriteStream', {
path: '/home/temp.gz',
data: fs.createReadStream('./local/temp.gz')
//data: fs.readFileSync('./local/temp.gz')
//data: 'some local data'
})
download file from remote server
conn.sftp('fastGet', {remotePath: remotePath, localPath: localPath})
upload local file to remote serer
conn.sftp('fastPut', {localPath: localPath, remotePath: remotePath})
download remote server file
conn.sftp('readFile', {path: remoteFilePath, option: option})
upload file to remote server
conn.sftp('writeFile', {path: remoteFilePath, data: localFilePath, option: option})
append local data to remote server file
conn.sftp('appendFile', {path: remoteFilePath, data: localData, option: option})
create new directory recursively.
conn.sftp('mkdir', {path: remoteFilePath});
remove the directory recursively.
conn.sftp('rmdir', {path: localPath});
delete file.
conn.sftp('delete', {path: remoteFilePath});
rename remoteSourcePath to remoteDestPath (removes remoteSourcePath).
conn.sftp('rename', {oldPath: remoteSourcePath, newPath: remoteDestPath});
modify rights to remoteDestPath file
conn.sftp('chmod', {path: remoteDestPath, mode: mode});
####connect
connection config you will see here
close the sftp connection. when you need it, you can call it in then()
or catch()
.
conn.end();
FAQs
a SFTP client for node.js
The npm package sftp-client-promise receives a total of 32 weekly downloads. As such, sftp-client-promise popularity was classified as not popular.
We found that sftp-client-promise 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
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.
Research
/Security News
North Korean threat actors deploy 67 malicious npm packages using the newly discovered XORIndex malware loader.