super-sweeper v1.0.1

Super sweeper

Super sweeper is a cleanup tool helping you regain control over messy folders.

Installation

npm i -g super-sweeper

Usage

> super-sweeper -h
Usage: super-sweeper <command> [options]

Options:
  --version        Show version number                                 [boolean]
  -v, --verbose                                                        [boolean]
  -r, --retention  Retention expressed in format: 30d, 4h, 10m  [default: "30d"]
  -p, --path       Path to cleanup
  -c, --config     Path to config file with paths to cleanup            [string]
  --dry            Simulates a cleanup                [boolean] [default: false]
  -h, --help       Show help                                           [boolean]

Examples:
  Run with default config for ~/Downloads and ~/Desktop (screenshots only). 30
  days retention.
    $ super-sweeper

  Run for custom path with user-defined retention.
    $ super-sweeper --path your/path/here/ --retention 1h

  Run for custom config
    # config.js
    export default [
      {
        path: 'your/path/here',
        retention: '1h',
        match: /^DCIM/
      }
    }

    $ super-sweeper --config ./config.js

Configuration

The tool accepts configs in following format:

export default [
    {
        path: "/path/to/a/folder/",
        retention: "30d", // Ex. 1Y, 1M, 10d, 20h, 60m, 30s
        match: /^DCIM/, // JS RegExp matching files to remove
    },
    { path: "/another/path" }, // Take all defaults. Retention 30d, match all
];

Add program to launchd

Firstly, add following file to the LaunchAgents folder ~/Library/LaunchAgents/local.super-sweeper.plist. Please fill out program path and interval.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>Label</key>
        <string>local.super-sweeper</string>
        <key>ProgramArguments</key>
		<array>
			<string>/usr/local/bin/node</string> <!-- node path `which node` -->
            <string>/usr/local/bin/super-sweeper</string> <!-- location of the tool. You can get this by calling `which super-sweeper` -->
		</array>
        <key>StartInterval</key>
        <integer>3600</integer> <!-- interval in seconds. 3600s = 1h -->
    </dict>
</plist>

Run below commands to register launchd agent.

$ launchctl load ~/Library/LaunchAgents/local.super-sweeper.plist
$ launchctl start local.super-sweeper