shakr

installation

1. launch a command prompt
2. change directory to the intended installation path for shakr
3. run: npm install shakr
4. edit the newly created 'node_modules/shakr/config.json' file with your pertinent information

configuration (config.json)

• localPath: the local, project-level, working folder to watch for changes. Shakr will watch all subfolders.
• remotePath: the localPath's analog at a differing server, drive, folder, etc.
• folderPairings: a key-value array for folders which are not identically named on the local and remote paths.
• exclusions: a string array of folder names in which file changes should not be watched.
• extensions: a string array containing the file types to watch.

example configuration

the below configuration will watch the c:\rsc\prvd\commerceapplications tree for file changes. if a file changes in c:\rsc\prvd\commerceapplications\web\client\somefile.js it will be coppied to \\lm56order1\f$\fw\client\somefile.js. All file paths containing "someFolderName" and "other/folder" will be ignored.

{
	"localPath": "c:\\rsc\\prvd\\commerceapplications\\",
	"remotePath": "\\\\lm56order1\\f$\\",
	"folderPairings":{
		"web\\usercontrols": "fw\\usercontrols",
		"web\\client\\": "fw\\client\\",
		"application\\web\\pfprvdweb": "pfprvdweb"
	},
	"exclusions": [
		"someFolderName",
		"other/folder"
	],
	"extensions":[
		".css",
		".less",
		".aspx",
		".ascx",
		".js",
		".html",
		".svg",
		".master"
	]
}

use

to use the tool, execute the cmd file found in your installation path + node_modules/shakr/shakr.cmd