Skip to main content

AI-powered file organization system using PARA + Zettelkasten methodology

Project description

file-org-wiz

An AI-powered file organization system using the PARA + Zettelkasten methodology.

License: MIT Python 3.8+ PyPI Tests

A complete file organization system that provides tools to reorganize any computer's files with consistent structure, naming conventions, and documentation using the PARA (Projects, Areas, Resources, Archive) methodology combined with Zettelkasten principles.

Features

  • PARA Folder Structure: Action-oriented organization by Projects, Areas, Resources, and Archive
  • Deep File Scanning: Recursive analysis and intelligent categorization
  • Duplicate Detection: Content hash + name similarity matching
  • Zettelkasten Integration: MOCs, atomic notes, bidirectional links for Obsidian vaults
  • MCP Server: HTTP API for integration with AI coding assistants
  • Natural Language Commands: Parse requests like "organize my downloads folder"
  • Auto-Tagging: Generate semantic tags from filenames and readable file content
  • Smart Renaming: Infer better filenames from content with auto_describe
  • Templates: Apply finance, research, and media folder templates instantly
  • Analytics Dashboard API: Inspect file types, categories, duplicate waste, tags, and largest files
  • dry-Run Mode: Preview changes before applying
  • Skill System: Direct integration with OpenCode and other AI tools
  • Multi-System Support: Works with Claude, Copilot, Cursor, Codex, and 15+ other AI systems
  • Safe by Design: Path validation, backup-first execution, no data deletion without confirmation

Quick Start

Install

# Install from source
pip install -e .

# Or install with pipx (recommended for CLI tools)
pipx install .

Start the MCP server:

file-org-wiz --port 5000 --mount /YOUR/MOUNT --backup /YOUR/BACKUP

Test:

curl http://localhost:5000/health

Preview (dry-run):

curl -X POST http://localhost:5000/organize \
  -H "Content-Type: application/json" \
  -d '{"mount_path": "/YOUR/MOUNT", "dry_run": true}'

Organize (for real):

curl -X POST http://localhost:5000/organize \
  -H "Content-Type: application/json" \
  -d '{"mount_path": "/YOUR/MOUNT", "backup_path": "/YOUR/BACKUP", "do_backup": true}'

API Endpoints

Endpoint Method Description
/health GET Health check
/organize POST Execute reorganization
/backup POST Create backup
/structure GET Get directory structure
/analytics GET Get organization analytics
/apply-names POST Apply naming convention
/analyze-file POST Generate tags and smart filename suggestion
/nlp-command POST Parse or execute natural language requests
/mcp-manifest GET List available tools

Organize Options

{
  "mount_path": "/path/to/mount",
  "backup_path": "/path/to/backup",
  "do_backup": true,
  "template": "finance",
  "dry_run": true,
  "create_vault": false,
  "vault_path": "/path/to/vault"
}

With dry_run: true, the response includes suggested_actions preview.

Smart Naming

{
  "file_path": "/path/to/file.txt",
  "auto_describe": true,
  "version": 1
}

Natural Language Commands

curl -X POST http://localhost:5000/nlp-command \
  -H "Content-Type: application/json" \
  -d '{"command": "preview organize my downloads folder"}'

Analytics

curl "http://localhost:5000/analytics?path=/YOUR/MOUNT"

Documentation

Document Purpose
QUICKSTART.md Get started in 5 minutes
USER_GUIDE.md Complete user guide
FAQ.md Frequently asked questions
REFERENCE_CARD.md Print-ready reference
CHEATSHEET.md All commands
CONTRIBUTING.md How to contribute
Why_PARA_Zettelkasten.md Methodology explanation

Templates

Template Purpose
docs/templates/01_meeting.md Meeting notes
docs/templates/02_daily.md Daily logging
docs/templates/03_project_moc.md Project hub
docs/templates/04_area_dashboard.md Area dashboard
docs/templates/05_project_note.md Project notes

Installation by System

Choose your AI system below:

System Installation
Claude Desktop docs/install/claude_desktop.md
Claude Code docs/install/claude_code.md
GitHub Copilot docs/install/copilot.md
OpenAI Codex docs/install/codex.md
Codeium docs/install/codeium.md
Tabnine docs/install/tabnine.md
Cody docs/install/cody.md
Continue docs/install/continue.md
Cursor/Windsurf docs/install/cursor_windsurf.md
Aider docs/install/aider.md
OpenCode docs/install/opencode.md
Raycast docs/install/raycast.md
Mint CLI docs/install/mint.md
gptme docs/install/gptme.md
Amazon Q docs/install/amazonq.md
Any (HTTP) docs/install/mcp_generic.md

Folder Structure Created

MOUNT_PATH/
├── 00_INBOX/                    # Drop zone - process daily
├── 01_PROJECTS/               # Time-bound deliverables
│   ├── Projects/
│   ├── Client-Work/
│   └── Personal/
├── 02_AREAS/                  # Ongoing responsibilities
│   ├── Health/
│   ├── Finance/
│   ├── Home/
│   ├── Learning/
│   └── Personal/
├── 03_RESOURCES/              # Reference material
│   ├── AI/
│   ├── Tech/
│   ├── Career/
│   ├── Development/
│   ├── Media/
│   ├── Reading/
│   └── Tools/
├── 04_ARCHIVE/               # Completed items
├── 90_TEMPLATES/             # Reusable templates
└── 99_SYSTEM/                # Rules & documentation
    ├── File Naming Rules.md
    ├── Tag Rules.md
    ├── Vault Rules.md
    └── File_System_User_Guide.md

File Naming Convention

Pattern: YYYY-MM-DD__context__description__vNN.ext

Before After
final.docx 2026-04-25__career__resume__v01.docx
Meeting Notes.docx 2026-04-24__turin-tech__client-meeting__v01.docx

Requirements

  • Python 3.8+
  • Flask >= 2.3.2
  • An AI agent that can execute bash commands, read/write files, and navigate directory structure

Security

See SECURITY.md for our security policy and reporting guidelines.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for detailed guidelines on our development process, coding standards, PR workflow, and code of conduct.

License

MIT — see LICENSE for details.


Your digital life is an extension of your mind. Organize it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

file_org_wiz-1.3.0.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

file_org_wiz-1.3.0-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

Details for the file file_org_wiz-1.3.0.tar.gz.

File metadata

  • Download URL: file_org_wiz-1.3.0.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for file_org_wiz-1.3.0.tar.gz
Algorithm Hash digest
SHA256 2d9d1a4d88c9f636e81193cea1620165af759f6cd25f6b273cc25661dc6bb2ad
MD5 c960012026cd0cc75bdc5a99cc6b56e2
BLAKE2b-256 9b76a6b35a4f9d5fbe9f7abf304bd0077b09967d911d4af93b147c7168380b65

See more details on using hashes here.

File details

Details for the file file_org_wiz-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: file_org_wiz-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 27.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for file_org_wiz-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ab4fe0c58ba4791b853df8daac05a1029a3fddc8950ca81dee7fc13530a3b19
MD5 7a37b9233d08ac130c9da7dd46be2518
BLAKE2b-256 9f33bd721c9e3272f68c0c00ebf81991279395bdf7d3810dc21f237cbcfaab43

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page