Local File Organizer

🚀 本地文件整理器

本地文件整理器是一個基於 Python 的文件組織系統，藉助模型上下文協議（MCP），能夠安全地在不同目錄間管理和組織文件，有效提升文件管理效率。

🚀 快速開始

本地文件整理器是一個強大的文件組織系統，利用模型上下文協議（MCP）安全地管理和組織文件。以下是快速上手的步驟：

安裝

# 克隆倉庫
git clone https://github.com/diganto-deb/local_file_organizer.git
cd local_file_organizer

# 安裝依賴項
pip install -r requirements.txt

配置允許目錄

創建或修改項目目錄中的 .cursor/mcp.json 文件：

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "/path/to/organize/dir1",
        "/path/to/organize/dir2"
      ]
    }
  }
}

將路徑替換為您要允許 MCP 服務器訪問的目錄。

啟用 MCP 服務器

在配置 .cursor/mcp.json 文件後：

1. 重啟 Cursor。
2. 打開 Cursor 設置（⚙️）。
3. 進入 MCP。
4. 您應該會在 MCP 服務器列表中看到 filesystem 服務器，服務器應顯示名稱為 "filesystem"。
5. 點擊旁邊服務器名稱的切換開關以啟用它。

使用文件組織命令

一旦啟用了 MCP 服務器，您就可以直接在 Cursor 的代理中使用文件組織命令：

# 列出所有可用類別
list_categories

# 分析目錄而不進行更改
analyze_directory /path/to/directory

# 在目標目錄創建分類文件夾
create_category_directories /path/to/target

# 按類型整理文件
organize_files /path/to/directory

# 搜索文件
search_files /path/to/directory "*.jpg"

✨ 主要特性

• 目錄安全：僅操作於顯式允許的目錄，保障文件操作的安全性。
• 智能分類：根據擴展名將文件整理為以下類別：
  • 文檔（PDF、DOC、DOCX、TXT、RTF、MD、HTML、JSON、CSV 等）
  • 圖像（JPG、PNG、GIF、SVG、WEBP、HEIC 等）
  • 視頻（MP4、MOV、AVI、MKV 等）
  • 音頻（MP3、WAV、OGG、FLAC 等）
  • 歸檔（ZIP、RAR、7Z、TAR 等）
  • 代碼（PY、JS、HTML、CSS、Java 等）
  • 應用程序（DMG、EXE、MSI 等）
  • 其他（未分類的文件類型）
• 項目檢測：識別代碼倉庫以避免干擾，確保項目文件不受影響。
• 遞歸處理：可以分析和整理嵌套目錄結構，全面管理文件。
• 資源高效：針對大型目錄結構進行了性能優化，提升處理效率。
• 詳細分析：提供按類型分佈的文件洞察，讓您瞭解文件分佈情況。

🔧 技術細節

該系統使用了以下技術實現：

• MCP Python SDK：用於核心服務器實現，確保系統的穩定性和可靠性。
• Filesystem MCP Server：用於文件系統的處理，高效管理文件操作。
• Pathlib：用於路徑操作，簡化路徑處理流程。
• 類型註解：用於代碼的可維護性和清晰度，方便後續開發和維護。

📚 詳細文檔

計劃功能

未來版本將添加以下功能：

• 支持更多文件類型和分類，滿足更多使用場景。
• 提供圖形用戶界面（GUI），提升用戶操作體驗。
• 集成雲存儲支持，方便文件的雲端存儲和管理。
• 增強的安全性和權限控制，進一步保障文件安全。

貢獻

如需貢獻，請訪問項目倉庫：https://github.com/diganto-deb/local_file_organizer

📄 許可證

該軟件受 MIT 許可證的保護。請參閱 LICENSE 以瞭解詳細信息。