Vault Path Portability finds file names that break when a vault moves

Find vault paths that can fail on Windows, macOS, Linux, iOS or Android before you move your notes.

MIT · no telemetry · core features free

A vault path report groups the flagged paths by portability rule.
Open larger
version
1.2.0
released
downloads
8
review
Passed
health
Excellent
license
MIT
listed for
Desktop, Mobile
obsidian
1.13.4 or later

The directory takes these platforms from the plugin manifest. The automated tests run in the desktop app only.

Directory facts fetched from community.obsidian.md/users/theluckystrike.

About Vault Path Portability

You move or sync a vault between Windows, macOS, Linux, iOS and Android.

Run one scan, and the report groups the risky paths of your vault by the rule they fail. It checks notes, attachments and folders that Obsidian has indexed. Scanning never renames, edits or deletes a file.

A vault scan runs and the path report is reviewed.Play demo

Free features

A report grouped by rule

The scan finds case-fold collisions such as Note.md and note.md, Windows reserved names, trailing dots or spaces and unsafe characters. It also flags link delimiters, names over 255 UTF-8 bytes and Windows path length risks.

A case-fold collision group holds Note.md and note.md.
Open larger

Open files and copy the whole report

Select Open file beside a result to inspect that note or attachment. Copy Markdown runs a fresh scan and puts the full report on the clipboard. Both actions need no account or payment.

The copy action sits beside the scan controls.
Open larger

Rename suggestions after your click

The report previews a safe destination beside a flagged path. Select Review rename to compare the current path with its suggestion. Pro adds the action that applies it.

A rename review in the free tier shows the Pro rename action turned off.
Open larger

Automatic counts and report notes

Manual scans and the copied report are free. Pro adds scans after file changes, a status bar count and export to a note.

The full scan, file opening and Markdown copy are free, and Pro adds rename suggestions, automatic scans with a status count and report notes.

Pro features

Pro costs $5 a month or $15 one time through GitHub Sponsors. One sponsorship turns on Pro in every plugin that has it.

Apply a suggested rename Pro

Select Rename this path to rename one file or folder through the FileManager API of Obsidian. Obsidian updates internal links according to your link setting. The plugin refuses the rename when the path or the target changed after the scan.

Scans on change and report notes Pro

Pro can scan after a file or folder is created, renamed or deleted, and the desktop status bar shows the count of findings. Export to note writes the report to a new note in the vault root. Existing report notes are never overwritten.

The settings show the optional automatic scan control and the GitHub Sponsors section.
Open larger

Set up Vault Path Portability

needs

  • Obsidian 1.13.4 or later

steps

  1. Back up the vault before a move or a folder reorganization.

  2. Run Scan vault paths from the command palette.

  3. Review each rule group, open files where you need context and copy the report.

  4. Rename the paths by hand or with a Pro suggestion, then scan again before you copy the vault.

If the app can't find a new plugin yet, try again later. Obsidian says a plugin that passes the review shows in the app within 24 hours.

Why this exists

Forum users report sync trouble with case-only renames and with special characters, and they ask how to rename files without breaking links.

How it compares

Safe Filename Linter
Safe Filename Linter replaces illegal and link-breaking characters, with free automatic and bulk renames. Vault Path Portability reports case collisions, reserved names and length risks, and Pro renames one path at a time.

Need a change for your team? I build custom Obsidian plugins and features.

Questions about Vault Path Portability

Does the scan change my files?

No. Scanning only reads the paths that Obsidian has indexed. A rename happens only when you select Rename this path, which needs Pro.

Does it find accented names that look the same?

No. Obsidian normalizes its index before the plugin can read the names, so the scan cannot detect NFC and NFD twins. Check the source file system separately for those conflicts.

How does it check path length?

On desktop it adds the absolute vault root to the relative path and checks the Windows limit of 260 UTF-16 units. Each name also has a separate check of 255 UTF-8 bytes. A destination root can be longer than the current one.

Does it scan hidden folders?

No. The scan uses the paths that Obsidian has indexed. Hidden configuration folders, excluded content and files that failed to enter the index can be absent from the report.

Network use

The scan runs on your device and makes no network request before you select Sign in with GitHub. Sign in sends the client ID and the read:user scope to github.com, and the sponsorship check sends your token to api.github.com. No note text, file names or other vault data goes to either host.

Read the full network disclosure

Questions or ideas?

Tell me what is broken in Vault Path Portability, or what it should do next.

Send feedback

Vault Path Portability 1.2.0, MIT license

MIT · no telemetry · core features free