@joinsrl/samba-client/README.md

wrapper for smbclient

node-samba-client
=================

Node.js wrapper for smbclient


Requirements
------------
Smbclient must be installed. This can be installed on OSX with Homebrew [using this script](https://raw.githubusercontent.com/Homebrew/homebrew-core/1fd22fea2426e1ae34e85177234c6e59f63add58/Formula/samba.rb) and on Ubuntu with `sudo apt-get install smbclient`.

API
-------------

	var SambaClient = require('samba-client');

	var client = new SambaClient({
	  address: '//server/folder', // required
	  username: 'test', // not required, defaults to guest
	  password: 'test', // not required
	  domain: 'WORKGROUP' // not required
	});

	// send a file
	client.sendFile('somePath/file', 'destinationFolder/name', function(err) {});

	// get a file
	client.getFile('someRemotePath/file', 'destinationFolder/name', function(err) {})