README file from
GithubFolderer
An Obsidian plugin that automatically runs rules on markdown files in monitored folders.
Features
- Monitored folders — designate any vault folder as a watched location
- Rule engine — attach multiple rules to each folder, each with its own trigger, conditions, and actions
- Triggers — fire on file creation or in-folder rename/move
- Conditions — filter by file name, file path, or frontmatter property using operators: contains, starts with, ends with, matches regex, and exists
- Condition groups — combine conditions with All, Any, or None logic
- Actions — append or prepend text to a file automatically
- Multiple actions per rule — chain several actions in a single rule
- Rule ordering — reorder rules with up/down buttons to control execution sequence
Installation
- Open Obsidian → Settings → Community Plugins
- Click Browse and search for Folderer
- Install and enable the plugin
Manual
- Download the plugin files from the releases page
- Inside your vault, go to
.obsidian/plugin/folderer(create the directories if needed) - Move the downloaded files into the previous folder (uncompress them first)
- Also inside your vault, edit
.obisidian/community-plugins.jsonand add "folderer" to the list - Restart Obsidian
Quick Start
- Open Settings → Folderer
- Add a monitored folder (e.g.
Literature) - Create a rule for that folder:
- Trigger: File created
- Action: Append text →
#literature
- Create a
.mdfile insideLiterature/—#literatureis appended automatically
See the full documentation for all available conditions and actions.
Development
Requires mise for Node.js management.
git clone https://github.com/alvaromateo/folderer.git
cd folderer
npm install
npm run dev # watch mode — rebuilds on save
npm test # unit tests
Open Obsidian on ./test-vault/ and enable Folderer under Community Plugins.
License
MIT © Alvaro Mateo