External Rename Handler

This is a plugin for Obsidian that handles renames in the vault made outside of Obsidian app.

By default, Obsidian does not handle renames made outside of the app. It treats them as pair of create/delete events.

This plugin handles renames made outside of Obsidian app by treating them as a single rename event.

[!WARNING]

The plugin works only if Obsidian is running during the external renames.

The plugin only handles renames for those files/folders that Obsidian tracks.

The plugin only handles renames made inside the vault.

The plugin doesn't handle the renames made outside of the vault even if the renamed files are referenced within the vault.

The plugin doesn't handle the renames in files/folders that start with . (dot).

Demo vault

A demo vault with usage examples ships with every release. You can access it via any of the following:

1. Running the External Rename Handler: Open demo vault command.
2. Downloading external-rename-handler-demo-vault-<version>.zip (<version> is the release version) from the Releases.
3. Browsing its source in demo-vault/ in this repository.

Installation

The plugin is available in the official Community Plugins repository.

Beta versions

To install the latest beta release of this plugin (regardless if it is available in the official Community Plugins repository or not), follow these steps:

1. Ensure you have the BRAT plugin installed and enabled.
2. Click Install via BRAT.
3. An Obsidian pop-up window should appear. In the window, click the Add plugin button once and wait a few seconds for the plugin to install.

Debugging

By default, debug messages for this plugin are hidden.

To show them, run the following command:

window.DEBUG.enable('external-rename-handler');

For more details, refer to the documentation.

Support

My other Obsidian resources

See my other Obsidian resources.

License

© Michael Naumov