Skip to content

Kas-sim/Foldr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FOLDR

PyPI Version Python License Downloads Platform

A safe, fast, and predictable CLI tool to organize files in a directory by file extension.

FOLDR is designed to clean up messy folders without touching your existing folder structure. It focuses on files only, with a built-in --dry-run mode so you can see exactly what will happen before anything moves.


Features


  • Organizes files by extension into clear categories
  • Never modifies or moves existing folders
  • Dry-run mode to preview actions safely
  • Handles filename conflicts automatically
  • Cross-platform (Windows, macOS, Linux)

Installation


pip install foldr

Requires Python 3.9+.


Usage


Organize a directory:

foldr <directory>

Preview actions without moving files:

foldr <directory> --dry-run

Example:

foldr ~/Downloads --dry-run

Note (paths with spaces):
If the directory path contains spaces, wrap it in quotes.

Example:

foldr "D:\My Downloads" --dry-run

How It Works


  • Files are grouped into predefined categories based on extension
  • Category folders are created only if needed
  • If a filename already exists, FOLDR safely renames the file
  • Directories are detected, counted, and left untouched

Safety First


Folders are never modified

  • Use --dry-run to preview changes

  • No recursive behavior (by design)

Future versions may introduce optional recursive mode.


Example Output


Mode: DRY RUN

report.pdf -> Documents
song.mp3 -> Audio
script.py -> Code

Total items: 24
Skipped directories: 6
Documents: 3
Audio: 1
Code: 1
Other files: 2

Roadmap


  • Optional --recursive flag

  • User-defined category configuration

  • Exclusion rules


Author

Muhammad Qasim

GitHub: https://github.com/Kas-sim LinkedIn: https://www.linkedin.com/in/kas-sim/


License

MIT License

About

CLI Tool to Organize your messy files on single command

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages