TABLE OF CONTENTS



Overview



Pinning allows you to pin files and folders that will permanently persist in the local cache. It is implemented for all operating systems macOS, Windows, and Linux (CLI only). This is especially useful when you need to make sure the data is on local disk and you don't want to rely on your internet connection and be dependent on latency and throughput problems. For example, you have a specific project (e.g. a folder) that you know you'll be working on for several days, once you pin that "project", as long as there is enough configured cache for it, Lucid will make sure all data is retrieved from the cloud for you to work directly on the local disk. Note that all pinned files and folders will be updated accordingly even if another user is making changes to the folders you've pinned (e.g. new files and folders are copied into a pinned folder etc.). 

Once all data is successfully pinned, you'll see a green pin next to the file or folder to show you that all data is downloaded locally. If new files or folders are created within a pinned directory a blue pin will appear showing you that data is actively retrieved from the cloud to get the pinned folder up-to-date. Since any other user can put as much data as they need, once the available size for pinning is 0 bytes on your machine, an orange pin will show you there is a problem with retrieving additional data and you will be able to tell exactly which files or folders were not able to fully download on the local disk.


Up to 80% of your configured total cache size is allowed to be used for pinning. This is to guarantee there is a free cache at all times for activities outside pinned entries.



Finder / File Explorer


Right-click on a file or folder to pin. You can also select multiple folders at once.




File/folder overlay icons in different states - blue (pinning), green (pinned), orange (cannot finish pinning). Supported for macOS and Windows.






Command-line


#lucid help pin

Usage:
lucid pin [--list]
lucid pin [--set] path
lucid pin --unset path
lucid pin --unset --all

Pin/unpin a folder/file locally (keep/remove a local copy)

Options:

[--list] List pinned entries
[--set] path The file/folder to be pinned. The path starts at the filespace root, not the local file system root.
--unset [path] The file/folder to be unpinned. The path starts at the filespace root, not the local file system root.
--all Unpin all entries


Using the `lucid cache` command you can see how much pinned data you have on disk.


State: enabled
Backend writes: enabled
Page size: 257KiB
Maximum configured size: 2.93GiB
Current size on disk: 2.93GiB
Pinned size on disk: 0B
Available size for pinning: 2.34GiB
Remaining upload: 0B



In order to monitor if there is pinning activity, you can run the following lucid perf command:


lucid perf --cache pagesPinned,pagesUnpinned,failedPagePins