Skip to content

Box Drive Paths

mrdulasolutions edited this page May 25, 2026 · 1 revision

Box Drive Paths

Per-OS, per-version paths the plugin looks for. Configured in references/box-drive-paths.json.

macOS

Box Drive version Mount path
Modern (Box Drive 2.x / macOS 12+) ~/Library/CloudStorage/Box-Box/
Legacy ~/Box/
Older (Box Sync — deprecated product) ~/Box Sync/

box-drive-detect walks these in order.

Windows

(Not supported in v0.0.x — planned for v0.0.4)

Box Drive version Mount path
Modern %USERPROFILE%\Box\
Legacy %USERPROFILE%\Documents\Box\

Linux

Box has no official Linux Drive client. Community workarounds:

  • WebDAV mount via davfs2 — Box publishes a WebDAV endpoint
  • rclone mount — third-party FUSE-based

Neither is officially supported by this plugin. If you've set one up and it presents as a real local FS path, declare the path in _box-memory.json.settings.box_drive_path_override:

settings:
  box_drive_path_override: "/home/user/box-webdav/"

box-drive-detect accepts the override but doesn't verify Box Drive process state (since the official Box Drive process isn't running). Sync state will report unknown.

Use at your own compliance risk — Box doesn't attest community workarounds.

Override mechanism

For any non-standard install (Box Drive on a different volume, custom path, etc.), declare in workspace config:

settings:
  box_drive_path_override: "/Volumes/external/MyBox/"

box-drive-detect checks this path in addition to the standard candidates.

Detection order

box-drive-detect checks in this order:

  1. box_drive_path_override (if set)
  2. macOS modern: ~/Library/CloudStorage/Box-Box/
  3. macOS legacy: ~/Box/
  4. macOS older: ~/Box Sync/
  5. (Windows + Linux in future versions)

Returns the first one that exists + is writable.

When Box changes mount paths

Box has changed mount paths several times (Box Sync → Box Drive → Box Drive in CloudStorage). When a new version ships:

  1. Open an issue with the new path
  2. We ship a patch release that adds the path to box-drive-paths.json
  3. The patch is config-only — no code change
  4. box-drive-detect picks up the new path automatically

This is documented in the plugin's release process for ease of updates.

See also

Clone this wiki locally