sortifiler-cli v0.2.0

Sortifiler CLI

Get your files sorted from the command line. 📚🗂🖥

Description

An opinionated command line interface to sort your files and folders easily while feeling like Hackerman.

Desktop app coming soon! 🚀

Everyday you look at your Desktop/Downloads folder and think, "Damn I need to clean up this mess". 🤦

That feeling is why this CLI now exists. 😆

Sortifiler CLI classifies files and folders and moves them into _Type folders for easy access at the root of your chosen directory. 🗃

Installation

To install Sortifiler CLI enter npm -g install sortifiler-cli into your terminal.

If you are looking for the Sortifiler API then check out Sortifiler!

Usage

sortifiler --help

  Usage
    $ sortfiler <path>

  Options
    no flags,                     Sorts all files and folders in a given path.
    --files, -f                   Sort all files in a given path.
    --folders, -F                 Sort all folders in a given path.
    --config, -c <filePath>       Use a custom configuration file.

  <path> is the path to directory that needs sorting

  Examples
    Sort all files and folders in the Downloads folder.
    $ sortifiler ~/Downloads
    Sorting ...
    Sorted ✔

    Sort all files on the Desktop
    $ sortifiler ~/Desktop --files
    Sorting files ...
    Sorted ✔

    Sort all folders in the Downloads folder
    $ sortifiler ~/Downloads --folders
    Sorting folders ...
    Sorted ✔

    Sort all files and folders on the Desktop using a custom configuration file
    $ sortifiler ~/Desktop --config ~/sortifiler.json
    Loaded configuration ✔
    Sorting folders ...
    Sorted ✔

How does the sorting work?

• Folders are classified using the best matching _Type folder based on the files within that folder (only 1 level down).
• Files are classified as follows:

• Note: This list maybe outdated please check out Sortifiler for the latest info.

Custom Configuration

You can customise the whitelist and sorting rules used by Sortifiler. Create a custom JSON file and then pass the file path to the config flag.

Example: sortifiler.json

{
  "whitelist": ["fileToIgnore.txt"],
  "rules": {
    "_Documents": ["*.pdf"],
    "_Music": ["*.mp3"]
  }
}

Development

Contributing

1. Fork it
2. Create your feature branch: git checkout -b feature/my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin feature/my-new-feature
5. Submit a pull request

Requirements / Dependencies

• npm

Version

0.2.0

License

GNU GPLv3