cleanup-backup

cleanup-backup

Delete files based on last modified date on the local file system or over FTP.

Personally, I use it to clean outdated backup files.

CLI usage

$ npm install -g cleanup-backup

# specify threshold and as many locations as you want
$ cleanup-backup --threshold 3years /path/to/local/dir ftp://user:password@host/

# or use config file
$ cleanup-backup --config /path/to/my/config/file

Personally, I use cleanup-backup with config file and put it into my crontab.

CLI options:

-t, --threshold Max age of files, can be in milliseconds or at human-readable format, like 2weeks, 3months, 2w, etc. More on human-readable time format see at ms package API.

-c, --config Path to config file. It may be .yaml or .json or .js. More on config file format below.

-h, --help Show help.

--version Show version number.

More CLI examples:

# Deletes all files that are older then two weeks at directory /path1 and at FTP resource.
$ cleanup-backup -t 2w /path1 ftp://host/

# Deletes all files that are older then 3 years at ftp resorce
$ cleanup-backup -t 3years ftp://user:password@resource/

Config file format

Config file may be YAML, JSON, Node module formatted. Thus, the supported file formats is .yaml, .json, .js respectively.

Config file must specify two properties:

1. Threshold - max age of a file. Can be integer number means it is milliseconds or human-readable format like 3 months. You can read more about human-readable format at ms package API.
2. Watch - array of locations to reap. Each entry may be local filesystem path or FTP URI.

You can see example config files here:

• YAML
• JSON
• Node module

Programmatic api

var CleanupBackup = require('cleanup-backup');

var cleanupBackup = new CleanupBackup(
    [
        '/absolute/path/to/dir',
        'ftp://mirror1.backup',
        'ftp://mirror2.backup'
    ],
    '4 years'
);

var cleanupBackup = new CleanupBackup(locations, threshold);

Instantiates CleanupBackup. No actions are performed here.

Both params are required.

locations is an array of locations (each location can be local file system path or FTP URI).

threshold set the max age of files to keep. Any files that are older than this will be removed.

cleanupBackpu.run(callback).then( => ).catch(err => )

Actually starts to remove files.

Provides node-style callback(err, value) and promise support.

License

MIT, see LICENSE for details.