node package manager


A simple wrapper to the Unix shred command.

Use Node JS to securely delete files on your server with Unix's shred command.

npm install shredfile

Licensed under the MIT License:

All of the values listed in the example below represent the default values for their respective configuration item.

You can simply do this:

var shredfile = require('shredfile')();

And, you'll be good to go.

BUT: If you want more control, you can specify all sorts of options.

var shredfile = require('shredfile')({
    shred_path: '/usr/bin/shred', // Path to shred binary on your server 
    force: false, // If true, changes permissions of file to allow writing if necessary 
    iterations: 3, // How many time to overwrite the file 
    bytes: null, // If specified, it will shred to specified bytes and then stop 
    remove: true, // If true, removes (unlinks) file after shredding 
    zero: true, // If true, adds final overwrite with zeros to hide shredding 
    debug_mode: false // Whether or not to log info/debug/error msgs to the console 

Here is a non-default values example (to help you get an idea of what the proper-looking values should be):

var shredfile = require('shredfile')({
    shred_path: '/usr/local/bin/shred', // Maybe yours is located here 
    force: true, // You do want to change permissions to force writing 
    iterations: 25, // You're paranoid. Writing over the file 25 times. 
    bytes: '70M', // You're shredding the first 70 MB of the file only 
    remove: false, // You want to shred the file but keep it there. 
    zero: false, // You don't care about hiding the fact that you shredde the file. 
    debug_mode: true // You want to know everything that happened. 

This method allows you to shred a one or many files.

  • files required (string or array) A path (string) or list paths (array) to file(s) you want to be shredded.
  • end_cb (function) Will be called when the shred is complete. It takes 2 parameters:
  • err (string or null) A standard error message string (null if no error)
  • file (string) The original files parameter passed into this shred method.
  • status_cb (function) Will be called everytime the status of a file is changed (ex. renaming and each overwrite iteration). It takes 4 parameters:
  • action (string) This will be either 'overwriting' or 'renaming'
  • progress (float) The percentage of the specific action that is complete (ex. 0.66)
  • file (string) File name of the file that is currently being acted upon
  • active_file_path (string) Full path to the file that is currently being acted upon
shredfile.shred('/a/picture/for_example.jpg', function(err, file) {
    if(err) {
    console.log("File has been shredded!");
shredfile.shred(['/a/picture/for_example.jpg','/a/different/file.dat'], function(err, file) {
    if(err) {
    console.log("Files have been shredded!");
}, function(action,progress,file,path) {
    progress = (Math.round((progress * 10000)) / 100);
    self.settings.logger.debug(action + ' ' + file + '' + progress + '%');