FileOrg - AI-Powered File Organization

Intelligent file organization tool using AI to analyze and categorize documents automatically.

Installation

Install from GitHub (Recommended)

Using pipx (Isolated environment)

pipx install git+https://github.com/leoliu5550/QualcommHackathon.git

Development Installation

git clone https://github.com/leoliu5550/QualcommHackathon.git
cd QualcommHackathon
pip install -e .              # Basic installation
pip install -e ".[dev]"       # With development tools
pip install -e ".[non-npu]"   # With CPU/GPU model support
pip install -e ".[docs]"      # With documentation tools

Installation Options

• Default: NPU API client (httpx) - smallest footprint
• [non-npu]: PyTorch + Transformers for CPU/GPU inference
• [dev]: Testing and code quality tools
• [docs]: Documentation generation tools

Note: PyPI package coming soon. Currently install from GitHub.

Usage

GUI Interface

fileorg start

Opens graphical interface with drag-and-drop support

Command Line

fileorg /path/to/folder           # Organize folder
fileorg /path/to/folder --preview # Preview mode (no file movement)
fileorg /path/to/folder --restore # Restore original structure

Windows Context Menu

# Install context menu
cd rkey_registry
install_key.bat

# Uninstall context menu
uninstall_key.bat

Right-click any folder to see "Organize with FileOrg" option

Configuration

Edit fileorg/ai/config.py:

"backend": "qualcomm"  # Use NPU API (default)
"backend": "local"     # Use local CPU/GPU (requires [non-npu] installation)

Key Features

• AI Content Analysis - Smart document type and content detection
• Auto Categorization - Creates meaningful folder structures
• Safe Preview - Review changes before execution
• One-Click Restore - Complete backup and restoration
• Batch Processing - Fast organization of large file collections

Supported Formats

PDF, Word, Excel, PowerPoint, TXT, HTML, JSON, CSV, XML, Markdown

Contributing

Issues and Pull Requests are welcome!

License

This project is licensed under the MIT License - see the LICENSE file for details.