Skip to content

Obsidian plugin: Automatically organizes files into folders based on their extensions.

License

Notifications You must be signed in to change notification settings

mofukuru/auto_file_organizer

Repository files navigation

Auto File Organizer (Pre-release)

The custom Obsidian plugin "Auto File Organizer" allows you to automatically sort files into designated folders based on their extensions. It's especially useful for users who want to streamline their file organization.

⚠️ Note This plugin is currently in pre-release. Its stability and compatibility are not fully guaranteed. If you encounter any issues, please consider reporting them to help improve the plugin.


Features

  1. Automatic Organization: Newly added files in your Vault are automatically moved to specified folders based on their extensions.

  2. Flexible Settings:

    • You can configure mappings between file extensions and folders.
    • Existing mappings can be edited or deleted through the settings tab.
  3. Folder Selection via Dropdown:

    • Lists all folders in your Vault, allowing you to easily select target folders for file organization.
  4. Notification Feature:

    • Provides notifications for file movement results and settings changes.
  5. Vault-wide Reorganization:

    • A feature to re-scan and organize the entire Vault after settings have been updated.

Installation

  1. Open the "Plugins" tab in Obsidian's settings menu.
  2. Select "Load Custom Plugins" and upload the plugin files from this repository.
  3. Enable the plugin.

Usage

  1. Configuring Folder Mappings:

    • Open the settings menu and add a new mapping under "Extension to Folder Mapping".
    • Enter the file extension (e.g., txt, md, etc.) and select the target folder.
  2. Editing Existing Mappings:

    • Edit or delete existing mappings directly from the list in the settings menu.
  3. Vault-wide Reorganization:

    • Click the "Reorganize Vault" button in the settings menu to sort existing files in your Vault.

Notes

  • Folder names must already exist in the Vault. The plugin will not function properly if non-existent folders are specified.
  • As this is a pre-release version, unexpected behavior may occur.

Planned Improvements

  • A feature to create custom folders.
  • Adding rules for organization based on specific conditions.
  • A setting to share configurations across multiple Vaults.

Bug Reports & Feedback

If you encounter any issues or have feature requests, please follow these steps to report them:

  1. Submit a detailed report on this repository's Issues page.
  2. If possible, include steps to reproduce the issue or provide error messages for better troubleshooting.

Thank you for using the plugin! 🙌

About

Obsidian plugin: Automatically organizes files into folders based on their extensions.

Resources

License

Stars

Watchers

Forks

Packages

No packages published