smb-unix-client

wrapper for smbclient

Usage no npm install needed!

<script type="module">
  import smbUnixClient from 'https://cdn.skypack.dev/smb-unix-client';
</script>

README

node-samba-client

GitHub package.json version GitHub issues GitHub last commit

Nodejs smb-unix-client wrapper for smbclient

Fork of samba-client on 2020-01-01 at version 3.0.0

Requirements

Requires Node.js 10+ Smbclient must be installed. This can be installed on

  • Ubuntu with sudo apt-get install smbclient.
  • Centos with sudo yum install smbclient.

Testing with smblient 4.9.1

API

const SambaClient = require('smb-unix-client');

const client = new SambaClient({
    address: '//server/share', // required (Can use '\\\\server\\share' syntax)
    username: 'test', // not required, defaults to guest
    password: 'test', // not required
    domain: 'WORKGROUP', // not required
    port: 8080, // not required
    encrypt: true
});

// send a file
await client.sendFile('somePath/file', 'destinationFolder\\name');

// get a file
await client.getFile('someRemotePath\\file', 'destinationFolder/name');