Auto Organize

Auto Organize CLI

Auto Organize CLI is a powerful command-line tool designed to streamline the process of organizing files on your local machine. This utility excels in cleaning up directories that commonly accumulate clutter, such as Downloads or Desktop folders, by automating the sorting process.

Problem Solved

As files pile up in various folders, users often face obstacles like:

• Disorganized files mixed by type.
• Time wasted on manual sorting.
• Increased risk of misplacing or accidentally deleting important files.

Auto Organize CLI effectively addresses these issues by providing an automated solution.

Key Features

• Automatic File Organization: Sorts files based on their extensions into predefined categories.
• Simulation Mode: Employ the --preview flag to see the intended changes without modifying any files.
• Type Filters: Fine-tune your organization with options to include or exclude specific file types using --only and --exclude flags.
• Safety Assurance: Only moves files—ensuring no accidental deletions occur.
• Cross-Platform Support: Compatible with Windows and Linux, with expected functionality on macOS thanks to Node.js support.

Basic Usage

1. Navigate to the target directory:

   cd /Users/Downloads
   

2. Execute the command:

   auto-organize || npx auto-organize
   

The tool will then create organization directories such as:

Images/
Documents/
Audio/
Video/
Archives/

And will organize the files accordingly:

photo.jpg -> Images/
document.pdf -> Documents/
song.mp3 -> Audio/
videos.mp4 -> Video/
archive.rar -> Archives/

Simulation Mode

To preview the organization before actual changes:

auto-organize --preview || auto-organize -p

Example output might appear as follows:

Images/
    photo.jpg
Documents/
    contract.pdf
Audio/
    song.mp3

Customization Flags

• --only <type>: Organize files of a specific type.

  auto-organize --only images
  

• --exclude <type>: Exclude specific types from being organized.

  auto-organize --exclude archives
  

• --help: Request assistance and view the available types.

  auto-organize --help || auto-organize -h
  

Supported File Types

• images
• documents
• spreadsheets
• presentations
• archives
• audio
• video
• code

Common Use Cases

• Organizing the Downloads folder
• Quick cleanup of the Desktop
• Automatic classification of project files, such as those in a /public directory

Contributions to improve this tool are welcome and encouraged.

For more information, please refer to the README available in the repository.