README.md

📁 folder-organizer

A simple CLI tool to automatically organize files in a folder based on their extensions — built with TypeScript.

---

✨ Features

• 📦 Organizes files into folders like Images/, Documents/, Videos/, etc.
• 🔍 Scans a given folder path
• 🪄 Creates directories if they don't exist
• 🗃️ Moves files based on common extensions
• 🧑‍💻 Written in TypeScript, bundled with tsup

---

🚀 Installation

Globally via NPM:

npm install -g folder-organizer

Or use it directly without installing

npx folder-organizer <path-to-folder>

---

🛠️ Command-line Options

Flag	Description
--verbose	Enables detailed logs of the file organization process.
--dry-run	Simulates the organization process without actually moving any files.

🛠️ Usage

folder-organizer <path-to-folder>

# Organize with detailed logs
folder-organizer /path/to/your/folder --verbose

# Preview actions without actually moving files
folder-organizer /path/to/your/folder --dry-run

# Combine both
folder-organizer /path/to/your/folder --verbose --dry-run

Example

folder-organizer <path-to-folder>

---