Smart Solutions
Need help?
  • 100% Free & MIT Licensed
  • No third-party data hosting

How to install SharePoint Smart Path Length

SPFx web part · about 10 minutes · Last updated · By Sean Regan

Stuck on approvals or tenant policies?

Let our team handle setup with you

Our Quick Start setup covers App Catalog deployment, permission approvals, and a guided first run, and we can help you prepare what your change board needs.

Smart Path Length at a glance

Product
SharePoint Smart Path Length
Type
SPFx web part (.sppkg)
Where it runs
Inside SharePoint Online pages, as the signed-in user
Admin needed
SharePoint Administrator, once, to deploy the package
Setup time
About 10 minutes
License
Free, MIT open source

Before you start

  • A Microsoft 365 tenant with SharePoint Online.
  • A tenant App Catalog site. If you do not have one, a SharePoint Administrator can create it in the SharePoint admin center under More features > Apps.
  • SharePoint Administrator or Global Administrator rights to upload and deploy the package once. End users need no elevated rights.
  • Site Owner (Full Control) rights on the site where you add the web part.

Install, step by step

  1. 1.Download the package

    Download the latest .sppkg file from the SharePoint Smart Path Length GitHub Releases page. It is a single file — there is no installer and nothing runs on a server.

  2. 2.Open your tenant App Catalog

    In the SharePoint admin center, go to More features > Apps > App Catalog, then open Apps for SharePoint.

  3. 3.Upload the package

    Drag the .sppkg file into the Apps for SharePoint library. SharePoint reads the manifest and shows a trust dialog.

  4. 4.Deploy and trust

    Choose whether to make the solution available to all sites in the organization, then select Deploy. Deploying tenant-wide saves adding the app to each site individually.

  5. 5.Add the app to a site

    On the SharePoint site where you want the tool, open Settings > Add an app (or Site contents > New > App) and pick the solution. Skip this step if you deployed tenant-wide with the app auto-installed.

  6. 6.Add the web part to a page

    Edit a modern site page, click the + to add a web part, search for the tool by name, and place it on the page. Publish the page.

Your first real result, in about 10 minutes

Installing is not the win — the win is one result you can show someone. Goal: Find every file that will break OneDrive sync and export the list.

  1. 1.Run the Explorer against the library

    Start with the library people complain about — the one where sync errors keep appearing.

  2. 2.Set the threshold

    Set the limit to match your users' sync root. A local root of about 80 characters leaves roughly 180 for the SharePoint path.

  3. 3.Read the highlighted paths

    Anything over the threshold is highlighted so you can see the offending folders at a glance.

  4. 4.Look for the pattern

    Long paths are almost always caused by one or two deep folder conventions repeated across projects.

  5. 5.Export the report

    Export to Excel so owners get an exact list of files to rename or relocate.

  6. 6.Re-scan after the fix

    Re-run the report to prove the library is now under the limit.

First run: what to do next

  • Set the local sync prefix to match your organization's naming so the projected local path length is realistic.
  • Scan one deeply nested library first — long paths cluster in a handful of folders.
  • Export the report and fix the folder names highest in the tree; renaming one folder shortens every path beneath it.

Troubleshooting

Reported lengths differ from what users see locally
Local length depends on the user's profile folder and the tenant and library names in the sync path. Adjust the prefix used in the report settings.
The scan misses items
It runs as the signed-in user. Items you cannot read are not returned.

FAQ

What are the limits?
SharePoint Online rejects full URLs beyond roughly 400 characters, while Windows applications commonly break past 260 characters on the synced local path.
Does it rename files for me?
No. It reports the offenders and where they sit so you can shorten folder names yourself.
Which languages does the interface support?
Smart Path Length supports 30 interface languages. It follows each signed-in user's Microsoft 365 display language, or the site's default, and falls back to English when needed. SharePoint file names, folder names, paths, and report data are not translated.

Stuck on approvals or tenant policies?

Let our team handle setup with you

Our Quick Start setup covers App Catalog deployment, permission approvals, and a guided first run, and we can help you prepare what your change board needs.

Install another tool