/organized-cli

🚀 Command-line tool to organize files in a folder by categorizing them into directories based on their types

Primary LanguageTypeScript

Organized CLI

banner

🚀 Organized CLI is a command-line tool to organize files in a folder by categorizing them into directories based on their types. It simplifies managing cluttered directories by grouping files like documents, images, videos, audio, archives, and more.

Node.js Badge oclif Badge TypeScript Badge Licence Licence

📖 Features

  • Automatically categorizes files into predefined folders:
    • Documents, Images, Videos, Audio, Archives, Code, Executables, and Others.
  • Supports various file types, including .pdf, .jpg, .mp4, .zip, .exe, and many more.
  • Lightweight and easy to use.
  • Provides visual feedback with styled logs and emojis.

🚀 Installation

Global Installation via NPM

Install Organized CLI globally using NPM:

npm install -g organized-cli

📂 Usage

To organize a folder:

organized -f <path/to/folder>

Example

Imagine you have the following folder structure:

Before Running organized:

$ ls ./my-folder
image1.jpg    video1.mp4    document1.pdf    archive1.zip    script.js

Run the command:

organized -f ./my-folder

After Running organized:

$ ls ./my-folder
Documents  Images  Videos  Archives  Code

Within each folder:

$ ls ./my-folder/Documents
document1.pdf
$ ls ./my-folder/Images
image1.jpg
$ ls ./my-folder/Videos
video1.mp4
$ ls ./my-folder/Archives
archive1.zip
$ ls ./my-folder/Code
script.js

⚙️ Options

  • -f, --folder: Specify the path to the folder to organize (required).

Example:

organized -f ~/Downloads

🎯 Supported Categories and File Types

  • Documents: .pdf, .docx, .txt, .xlsx, .pptx, .csv, .odt, .ods, .odp

  • Images: .jpg, .jpeg, .png, .gif, .svg, .bmp, .tiff, .webp, .ico, .heic

  • Videos: .mp4, .mkv, .avi, .mov, .wmv, .flv, .webm, .m4v, .3gp

  • Audio: .mp3, .wav, .aac, .flac, .ogg, .m4a, .wma, .aiff, .opus

  • Archives: .zip, .rar, .7z, .tar, .gz, .bz2, .xz, .iso

  • Code: .js, .ts, .jsx, .tsx, .py, .java, .c, .cpp, .html, .css, .json, .xml, .yml, .sql

  • Executables: .exe, .dmg, .sh, .bat, .msi, .apk

  • Others: Any file type that does not fit into the above categories.

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.