Skip to content

ChristianRincon/auto-organize

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

146 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Auto Organize CLI Banner

NPM Version NPM Downloads NPM Last Update


Auto Organize CLI

Read this in: English | Spanish


A command-line tool (CLI) to automatically organize files in any directory on your system.


What problem does it solve?

When working with folders that accumulate files (Downloads, Desktop, projects, etc.), things usually get messy:

  • Files mixed by type.
  • Time wasted manually sorting files.
  • Risk of moving or deleting the wrong files.

Auto Organize CLI automates and fixes this process.


Key Features

  • Automatic file organization by type (based on file extensions).
  • Simulation mode (--preview) to preview changes.
  • Type filters (--only, --exclude).
  • Only moves files — never deletes them.
  • Tested on Windows and Linux (macOS compatibility is expected due to Node.js cross-platform support).

Installation

Requires Node.js >= 16

Download Node here

Option 1: Without installation (For one-time use)

npx auto-organize

Option 2: Global Installation (For regular use)

npm install -g auto-organize

Basic Usage

Navigate to any directory on your system. For example:

cd /Users/Downloads

Then run:

auto-organize || npx auto-organize

Depending on the files present, it will create folders such as:

Images/
Documents/
Audios/
Videos/
Archives/

And move files into their corresponding folders.

photo.jpg -> Images/

document.pdf -> Documents/

song.mp3 -> Audios/

video.mp4 -> Videos/

archive.rar -> Archives/

Example

auto-organize example


Simulation Mode (preview)

Preview the organization before applying real changes:

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

Example output:

Images/
    photo.jpg

Documents/
    contract.pdf 

Audios/    
    song.mp3

Example

auto-organize preview example

Available Flags

--only <type>

Organize only the specified file types (if there is more than one type, separate the types with a comma).

auto-organize --only images
auto-organize --only images,videos

--exclude <type>

Excludes the specified file types (if there is more than one type, separate the types with a comma)

auto-organize --exclude archives
auto-organize --exclude archives,documents

--help

Display the help guide and available types.

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

Supported Types

  • images
  • documents
  • spreadsheets
  • presentations
  • archives
  • audios
  • videos
  • codes

Common Use Cases

  • Organizing the Downloads folder
  • Quick Desktop cleanup
  • Automatically classifying project files (e.g. a /public directory)

Contributing

Contributions are welcome:

  1. Fork the project.
  2. Create a feature branch: git checkout -b feature/{your-feature}
  3. Commit your changes: git commit -m 'Add your feature'
  4. Push the branch: git push origin feature/{your-feature}
  5. Open a pull request.

License

  • MIT

Author

About

This CLI tool provides an automated way to organize your files on your local machine.

Topics

Resources

License

Stars

67 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors