Skip to content

Python CLI tool to organize files by extension. Automatically sort images, documents, videos, and more into neat folders

Notifications You must be signed in to change notification settings

anmoljhamb/neatify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Neatify

A simple CLI tool to organize files in a folder by their extensions.

Features

  • Automatically organize files into folders by type (images, documents, videos, etc.)
  • Manage custom extension mappings
  • Add, remove, and list file extension categories
  • Restore default extension mappings

Screenshot

Neatify in action

Organizing files with Neatify

Installation

From Source

# Clone the repository
git clone https://github.com/anmoljhamb/neatify.git
cd neatify

# Install in development mode
pip install -e .

Using pip

pip install neatify

Getting Started

After installation, you'll need to set up your configuration file before organizing files.

  1. Generate the default configuration:
   neatify default

This creates a comprehensive list of file extensions organized by categories (Images, Documents, Videos, etc.).

  1. Verify your configuration (optional):
   neatify list

This shows all configured categories and their extensions.

  1. Organize your first folder:
   neatify organise /path/to/folder

Note: Running neatify organise without first running neatify default will fail because no configuration file exists yet.

Usage

Organize a Folder

neatify organise /path/to/folder

This will organize all files in the specified folder into subfolders based on their file types.

List Extensions

View all configured file extension categories:

neatify list

Add an Extension

Add a new extension to a category:

neatify add Image .webp

Remove an Extension

Remove an extension from a category:

neatify remove Image .webp

Remove a Category

Remove an entire category:

neatify rmcat oldcategory

Clear All Extensions

Clear all extension mappings:

neatify clear

Restore Defaults

Restore the default extension mappings:

neatify default

Custom Extensions File

Use a custom extensions JSON file:

neatify --file custom_extensions.json organise /path/to/folder

Examples

# Organize your Downloads folder
neatify organise ~/Downloads

# Add .svg to the image category
neatify add Image .svg

# View all extensions
neatify list

# Remove a category you don't need
neatify rmcat Audio

About

Python CLI tool to organize files by extension. Automatically sort images, documents, videos, and more into neat folders

Topics

Resources

Stars

Watchers

Forks

Languages