File Organizer Documentation¶

Welcome to the File Organizer documentation. File Organizer is a local file management system. It uses AI. It protects your privacy. It runs locally by default. You can configure optional cloud providers.

Essentials¶

Use this workflow for your first run:

fo setup
fo preview ~/Downloads
fo organize ~/Downloads ~/Organized
fo undo

Run fo undo after you record at least one organize run.

Do you prefer a browser? Start with the Web UI Quick Start.

Quick Navigation¶

Key Features¶

• 🔒 Privacy-First: The software operates locally. Cloud providers are optional.
• 🤖 AI-Powered: The software uses local LLMs to organize files.
• 🎯 Methodologies: The software supports PARA, Johnny Decimal, and custom systems.
• 🔍 Smart Search: The software includes full-text search with filters.
• 📊 Analytics: The software shows storage analysis and detects duplicates.
• 🔄 Undo/Redo: You can reverse any operation instantly.
• 🎨 Multiple Interfaces: The software provides a Web UI, CLI, Terminal UI, and desktop app.
• 🔌 Extensible: You can add custom functions with plugins.

Supported File Types¶

File Organizer processes more than 48 file formats. These include:

• 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: Version 3.11 or higher
• RAM: 8 GB minimum (16 GB recommended)
• Storage: Approximately 10 GB for AI models
• Ollama: Latest version for local operation

Documentation Sections¶

Essentials¶

• Getting Started - Install the software.
• Core first run commands - Read about setup, preview, organize, and undo.
• Workflow Map - Find tasks by goal.
• Web UI Quick Start - Learn the browser interface.
• Troubleshooting - Solve common problems.

Advanced Setup & Interfaces¶

• AI Provider Setup - Configure OpenAI-compatible, Claude, llama.cpp, or MLX providers.
• Dependencies & Optional Extras - Install optional features.
• Models - Configure AI models.
• Audio & Video Processing - Setup media analysis.
• Web UI Guide - Manage files in the browser.
• Terminal UI Guide - Use the keyboard interface.
• Desktop App Guide - Use the native desktop window.
• CLI Reference - Read the full command reference.

API & Integration¶

• API Reference - Read the REST API documentation.
• Authentication - Manage API keys.
• WebSocket Events - Monitor real-time updates.
• Plugin Development - Build custom plugins.

Deployment & Administration¶

• Installation - Read setup instructions.
• Deployment Guide - Deploy to production environments.
• Configuration - Setup the environment.
• File Format Reference - Read about supported formats.
• Security - Review security practices.
• Monitoring - Monitor health and read logs.

Configuration & Migration¶

• Configuration Guide - Adjust global and profile settings.
• Path Standardization & Migration - Read about XDG paths.
• Path Deprecation Notice - Read about legacy paths.

Methodology Workflows¶

• Methodology selection workflow - Choose an organization system.
• Johnny Decimal User Guide - Setup Johnny Decimal.
• Johnny Decimal Migration Guide - Migrate existing structures.
• Johnny Decimal + PARA Compatibility - Combine systems.

Canonical setup references¶

• Optional extras matrix
• Provider matrix
• Model/provider precedence

CLI Feature Discoverability¶

• Search commands - Search files.
• Duplicate detection (dedupe) - Find duplicates.
• Undo/Redo history (history) - View operation history.
• Configuration (config) - Edit settings.
• Plugin marketplace (marketplace) - Find plugins.
• Copilot assistant (copilot) - Use the AI assistant.
• Profile behavior - Read about profile commands.

Development & Extension¶

• Architecture Guide - Read system design.
• Plugin Development - Create plugins.
• API Clients - Use client libraries.

Getting Help¶

• Issues: Report bugs on GitHub
• Discussions: Ask questions in discussions
• Troubleshooting: Read the Troubleshooting Guide
• FAQ: Read Frequently Asked Questions

Installation Quick Start¶

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

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

Read the Installation Guide to find detailed instructions.

Documentation Updates¶

This documentation supports File Organizer 2.1.1. To read older versions, look at the GitHub releases.

Last Updated: 2026-07-20 Version: 2.1.1

License¶

File Organizer is open source software. It uses the MIT License. Read LICENSE for details.