clutter-cutter
v1.3.1
Published
A CLI tool to organize your directories
Readme
Clutter Cutter
What it is?
clutter-cutter is a CLI tool to organize your directories. There are multiple commands and options available to organize or clear your folders/directories.
Tech Stack:
- Node.js for executing js/ts code.
commanderfor parsing commands entered by user in terminal.chalkfor coloring terminal outputs.orafor adding beautiful spinners/loaders during operations.treeifyfor displaying folder structure as a tree.@inquirer/promptsfor interactive selection of files.chokidarfor watching the folder and organize it in real-time whenever a new file comes.
How to use?
There are multiple commands available.
clutter-cutter organize <directory-path>for moving all the files in their respective categories.clutter-cutter organize <directory-path> --dry-runfor visualizing how the folder structure would look like without performing any operation.clutter-cutter organize <directory-path> --watchkeeps the process running and automatically organizes new incoming files in that directory.clutter-cutter organize <directory-path> --interactivelets users choose the files they want to organize and which ones they wanna ignore.clutter-cutter undo <directory-path>brings back previous folder structure.- Moreover, users can also create a
.clutterrc.jsonfile in the directory they want to organize, to provide custom file extensions and add files they want to ignore.
The structure of .clutterrc.json should be like this:
{
"categories": {
"images": [".jpg", ".jpeg", ".png", ".gif", ".svg", ".webp"],
"documents": [".pdf", ".docx", ".doc", ".txt", ".xlsx", ".pptx", ".csv"],
"archives": [".zip", ".tar", ".gz", ".7z", ".rar"],
"executables": [".exe", ".dmg", ".pkg", ".deb", ".sh"],
"code": [".js", ".ts", ".py", ".rs", ".go"],
"design": [".fig", ".psd", ".ai", ".sketch"]
},
"ignore": [
".DS_Store",
"Thumbs.db",
"node_modules"
]
}Note: if you don't provide directory-path, it will automatically organize the current directory.
Screenshots:
