File Organizer Documentation¶

Welcome to the File Organizer documentation! A privacy-first, AI-powered local file management system that organizes files intelligently using local LLMs with zero cloud dependencies.

🚀 Getting Started🖥️ Web Interface📚 API Reference🔧 Deployment👨‍💻 Development

New to File Organizer? Start here to understand the basics.

Using the web browser interface? Learn how to use all features.

Building integrations? Use our REST API.

Running your own instance? Deploy and configure File Organizer.

Extending File Organizer? Build plugins and integrations.

Key Features¶

🔒 Privacy-First: 100% local processing, zero cloud dependencies
🤖 AI-Powered: Uses local LLMs for intelligent file organization
🎯 Methodologies: Supports PARA, Johnny Decimal, and custom organization systems
🔍 Smart Search: Full-text search with filters and saved searches
📊 Analytics: Storage analysis, duplicate detection, and insights
🔄 Undo/Redo: Reverse any operation instantly
🎨 Multiple Interfaces: Web UI, CLI, and Terminal UI
🔌 Extensible: Plugin system for custom functionality

Supported File Types¶

File Organizer processes 43+ file formats including:

Documents: PDF, Word, Excel, PowerPoint, Markdown, EPUB
Images: JPEG, PNG, GIF, BMP, TIFF
Video: MP4, AVI, MKV, MOV, WMV
Audio: MP3, WAV, FLAC, M4A, OGG
Archives: ZIP, 7Z, TAR, RAR
Scientific: HDF5, NetCDF, MATLAB files
CAD: DXF, DWG, STEP, IGES

System Requirements¶

Python: 3.11+
RAM: 8 GB minimum (16 GB recommended)
Storage: ~10 GB for AI models
Ollama: Latest version for local inference

Documentation Sections¶

User Guides¶

Web UI Guide - Browser-based file management
Getting Started - Initial setup and overview
CLI Reference - Command-line interface guide
Troubleshooting - Common issues and solutions

API & Integration¶

API Reference - Complete REST API documentation
Authentication - API key management
WebSocket Events - Real-time updates

Deployment & Administration¶

Installation - Setup instructions
Deployment Guide - Production deployment
Configuration - Environment setup
Security - Security best practices
Monitoring - Health checks and logging

Development & Extension¶

Architecture Guide - System design
Plugin Development - Creating plugins
API Clients - Client libraries

Getting Help¶

Issues: Found a bug? Report it on GitHub
Discussions: Ask questions in discussions
Troubleshooting: Check the Troubleshooting Guide
FAQ: Browse Frequently Asked Questions

Installation Quick Start¶

Docker (Recommended)Python PackageFrom Source

git clone https://github.com/curdriceaurora/Local-File-Organizer.git
cd Local-File-Organizer
docker-compose up -d

Access at http://localhost:8000

pip install local-file-organizer
file-organizer serve

git clone https://github.com/curdriceaurora/Local-File-Organizer.git
cd Local-File-Organizer
pip install -e .
file-organizer serve

See the Installation Guide for detailed instructions.

Documentation Updates¶

This documentation is maintained for File Organizer v2.0+. For older versions, check the GitHub releases.

Last Updated: 2026-02-16 Version: 2.0.0+

License¶

File Organizer is open source and available under the MIT License. See LICENSE for details.