LucidLink CLI Reference

Advanced. Log level for the CLI

Advanced. Timeout (in seconds) for the REST calls to the daemon. Default is 60

Specify the REST service ip:port. Mutually exclusive with --id, --instance, and --name if a full REST endpoint, including port, is specified

Specify a daemon instance id. To see instance ids, use 'lucid list'.

Same as --id

Specify a Filespace name

Display cache information

Turn the cache on

Turn the cache off

Clear all evictable pages from the cache.

Advanced. Unpin all pages in the cache and restart pinning.

Size of the cache in MiB

Display compression statistics

Currently effective filespace configurations for this client

Local configurations scope. Affects only client where setting is applied

Global configurations scope. Affects each client that connects to the filespace unless overridden with --local for a particular client

Set configuration key(s). Defaults to `local` scope

Delete configuration key(s). Defaults to `local` scope

An admin user's password. Used with --global and --local options

Display the configuration settings per scope

Do not trim long configuration values

Advanced. Show info for internally configurable settings as well

Describe what each configuration key affects within Lucid and list its value constraints. Can be used with --KEY Configuration keys:

Flag denoting whether the audit log for filesystem events is enabled. The option must always be preceded by the '--global' option.

Maximum parallel compression/decompression tasks (0 means auto).

The threshold block size in bytes, at which blocks get destaged for parallel execution.

Turns compression on and off.

Advanced. Flag denoting whether decompression errors will be ignored.

Controls compression ratio vs. compression speed. 1 means maximum data compression (takes more resources on the local machine but reduces the network traffic).

Advanced. Flag denoting whether bit flip corretion is enabled in case of a checksum error during decryption.

Maximum parallel encryption/decryption tasks (0 means auto).

The threshold block size in bytes, at which blocks get destaged for parallel execution.

Advanced. Flag denoting whether decryption errors will be ignored.

Change the location of your data cache.

Local data cache size. The default is 25GiB. 80% of the size is available for pinning.

The amount of time lucid service will wait disconnected clients, before collecting their file locks

When enabled, prefetched data is stored in the in-memory cache in addition to the persistent data cache.

In-memory data cache size. The default is 64MiB.

The Stuck State Interval represents the length of time that has elapsed since the last known activity observed for that unique upload. Once this interval has been reached, the visible icon indicating an upload is in progress will change to indicate that there is a problem with that upload. Default value is 7200 seconds (2 hours).

Determines where the filespace will be mounted when no mount point is explicitly provided.

Advanced. Enable debug logs in the file system driver

Advanced. Windows only. Enable or disable file locking.

Forbid creating file names which are not compatible with Windows. These are names containing a special character \/:*?"<>| , have a trailing space or dot or represent a reserved name on Windows. Since Lucid version 2.0.3633, this setting is set globally to 1 upon Filespace initialization

Linux only. Enables the FUSE 'allow_other' mount option.When enabled, allows users other than the mounting user or root to access the filesystem.

Advanced. Windows only. File extensions for which fast unlocking will be applied.

Advanced. IO operation timeout in seconds. On Windows this setting affects only reads. On macOS both reads and writes are affected. On Linux it has no effect. The recommended timeout should be more than 'ObjectScheduler.RetryTimeout'. Use with caution.

Windows only. File extensions for which locking will be applied on open.

Linux only. Path which will be used as a mount point.

macOS only. Path which will be used as a mount point.

Windows only. Path which will be used as a mount point and drive letter.

Windows only. The label of the filespace drive.

Advanced. Windows only. The read-ahead size in bytes. Must be greater than or equal to 4096 (cpu page size) and an even power of 2, e.g. 4096, 16384, 65536, 262144, 1048576, 4194304. The default is 1048576.

Folder within the filespace to appear as the root folder. Path starts at the Lucid filespace root, not the local file system root.

Advanced. macOS only (Before Sequoia). Working with files containing any extended attribute with size greater than 512KiB before Sonoma and 4MiB on Sonoma will result in a termination of the file operation.

Windows only. Enable or disable Windows NTFS permissions. Requires admin privileges.

Advanced. Local metadata cache size. The default is 5GiB. Reducing the maximum cache size will not reduce the size of the cache file on disk.

Advanced. The size of the write batch used to evict keys.

Advanced. Turns metadata eviction on and off.

Advanced. Defines the threshold at which to start the eviction.

Advanced. Turns metadata fetching and prefetching on and off.

Advanced. Batch size of the metastore prefetcher. The default is 2MiB.

Advanced. Frontend timeout limit for the metastore prefetcher. Default is 75000 ms (75 seconds).

Advanced. Number of keys in a client synchronizer fetch. The default is unlimited (2^64 - 1).

Advanced. Batch size of the client synchronizer. The default is 2MiB.

GET request latency high alert threshold in milliseconds.

GET request latency low alert threshold in milliseconds.

GET request latency medium alert threshold in milliseconds.

Maximum parallel download connections - object store to client.

Maximum download rate in bytes/s - object store to client. The default is unlimited.

Maximum parallel upload connections - client to object store.

Maximum upload rate in bytes/s - client to object store. The default is unlimited.

PUT request latency high alert threshold in milliseconds.

PUT request latency low alert threshold in milliseconds.

PUT request latency medium alert threshold in milliseconds.

Advanced. Maximum time in seconds to retry any failed object store request. Recommended timeout should be less than 'FileSystem.IoTimeout'. Use option with caution.

File index sync request timeout. The default is 120 (2 min).

Location of the TeamCache proxy.

Specify the daemon instance, when running multiple instances

The filespace name

Specify the REST service TCP ip:port. Mutually exclusive with --instance and --fs if a full REST endpoint, including port, is specified

Don't read/save the configuration into the config file

Specify the path where the .json config file is located

Advanced. Enable runtime debugging

Advanced. Simulate a filespace entirely in memory

Advanced. Specify the desired filespace version (used with memfs only)

Advanced. Enable experimental features

User used to link to the Filespace.

User's password

Login token for authentication

Positional. Mount the Filespace at this mountpoint

Windows only. The label of the Filespace drive.

Folder within the Filespace to appear as the root folder. Path starts at the Lucid Filespace root.

Don't mount the Filespace after linking

Don't print link/unlink progress

Allows resetting of the local file index and data cache if inconsistency detected (e.g. caused by forceful shutdown)

Reset to default data cache location

Set root path for the Filespace data and metadata

Activate in snapshots mode

Activate the snapshot instead of the live Filespace

Advanced. Skip desktop shell integration for this mount (Explorer/Finder favorites shortcut, Windows Search indexer exclusion)

Specify a proxy server to tunnel all communication. Use the following format: [protocol://][user:password@]proxyhost[:port]. Supported protocols: http. Not applicable for Azure object storage.

Link to the Filespace in read-only mode

Link to the Filespace with metadata and data cache synchronization suspended

Linux only. Allow other users on this machine to access the filesystem

Link an external file to the filesystem

Show info about an existing external file

Positional. Path to the external file to link

Name of the data store

Object ID of the external file

Size of the external file in bytes. Access check of the object is skipped if provided. Invalid values could cause inability to correctly read the file.

Checksum (ETag) of the external file. Only valid when provided together with --size.

An administrator's password is required for external files operations

Indicates that the checks are to be run on a client metadb

Indicates that the checks are to be run on a server metadb

The filespace version in the specified filespace path

Required. Positional. Path to the metadb folder of the filesystem to be checked.

Advanced. This will just run checks and generate report of corrupted data in a format that can be passed to Lucid purge to cleanup the db

Run more extensive checks

Output each error in json format in a single line

Positional. Display help information for a specific command

Advanced. Show hidden options

Display statistics instead of a frequency distribution.

Display information for GET requests (default).

Display information for PUT requests.

Display information for FS read ios.

Display information for FS write ios.

Display information for FS getInfo ios.

Display information for all FS ios.

Omit timestamps from the latency output

Time interval in seconds at which to print the perf metrics. (default: 2)

Required. Positional. The Filespace name

User used to link to the Filespace.

User's password

Login token for authentication

Positional. Mount the Filespace at this mountpoint

Windows only. The label of the Filespace drive.

Folder within the Filespace to appear as the root folder. Path starts at the Lucid Filespace root.

Don't mount the Filespace after linking

Don't print link/unlink progress

Allows resetting of the local file index and data cache if inconsistency detected (e.g. caused by forceful shutdown)

Reset to default data cache location

Set root path for the Filespace data and metadata

Activate in snapshots mode

Activate the snapshot instead of the live Filespace

Advanced. Skip desktop shell integration for this mount (Explorer/Finder favorites shortcut, Windows Search indexer exclusion)

Specify a proxy server to tunnel all communication. Use the following format: [protocol://][user:password@]proxyhost[:port]. Supported protocols: http. Not applicable for Azure object storage.

Link to the Filespace in read-only mode

Link to the Filespace with metadata and data cache synchronization suspended

Linux only. Allow other users on this machine to access the filesystem

Print the output in JSON format instead of a table format

List the currently held file locks

Include short-lived locks

Advanced. Do not output pathnames

Positional. Possible values are: disabled, fatal, critical, error, warning, notice, info, debug and trace

Positional. Name of the logger whose level will be set or displayed

List all loggers

Set output in JSON format. Can be used only with the --list option.

Required. Positional. Logging format: default | detailed | [RAW - poco format]

Clear the metadata cache.

Display meta cache information

Positional. Mount the Filespace at this mountpoint

Windows only. The label of the Filespace drive.

Folder within the Filespace to appear as the root folder. Path starts at the Lucid Filespace root.

Advanced. Skip desktop shell integration for this mount (Explorer/Finder favorites shortcut, Windows Search indexer exclusion)

Linux only. Allow other users on this machine to access the filesystem

An administrator's password is required to use move-s3

Required. Use a specific bucket name. Make sure new bucket is an exact copy of the current bucket (see lucid status).

Use HTTP

Use HTTPS

S3 access key

S3 secret key

Required. Specify the name of the S3 compatible provider (AWS, DigitalOcean, ...)

Set a location constraint for the bucket. Required by some providers (AWS, GCP, ...).

Specify S3 region

Specify S3 compatible endpoint

Use virtual hosted-style bucket addressing instead of path-style.

List and explain all available perf metrics.

Time interval in seconds at which to print the perf metrics. (default: 2)

Omit timestamps from the performance metrics output

Show default list of metrics for each category.

Show extended list of metrics for each category.

Show full list of all metrics for each selected category.

Show only metrics for the specified (comma separated) groups (see option descriptions for the available groups).

Fail on perf retrieval errors

Category `time`. Groups: time. Metrics: currentDateAndTimeUTC.

Category `fs`. Groups: concurrency,iops,latency,notifications,size,throughput,total. Metrics: readBytes,writeBytes,reads,writes,opens,creates,dels,infos,moves,locks,other,ops,readFails,writeFails,openFails,createFails,delFails,infoFails,moveFails,lockFails,otherFails,opFails,readTime,writeTime,openTime,createTime,delTime,infoTime,moveTime,lockTime,otherTime,opTime,timedoutOps,readSize,writeSize,pendReads,pendWrites,pendOpens,pendCreates,pendDels,pendInfos,pendMoves,pendLocks,pendOther,pendOps,totalRead,totalWritten,notifActive,notifPending,notifProcessed,notifMetaPend,notifPathPend,notifPathDelPend,notifAttrPend,notifMeta,notifPath,notifPathDel,notifAttr.

Category `encryptor`. Groups: concurrency,throughput,total. Metrics: encryptBytes,decryptBytes,prlEncrypts,prlDecrypts,decryptFails.

Category `compressor`. Groups: concurrency,ratio,throughput,time,total. Metrics: currentDateAndTimeUTC,comprRatio,comprReadBytes,uncomprReadBytes,comprWriteBytes,uncomprWritesBytes,prlDecompresses,prlCompresses,totalComprReadBytes,totalUncomprReadBytes,totalComprWriteBytes,totalUncomprWriteBytes.

Category `prefetcher`. Groups: concurrency,efficiency,iops,throughput. Metrics: %covered,%accurate,prefetchBytes,totalPrefetchBytes,prodBytes,totalProdBytes,prefetches,prodPrefetches,pend,pendMem,pendOverlap,streams,maxIos,totalPrefetches.

Category `cache`. Groups: concurrency,efficiency,iops,latency,pinning,size,throughput,utilization. Metrics: %hits,readBytes,hitBytes,missBytes,prefetchBytes,writeBytes,bckWriteBytes,reads,hits,misses,prefetches,writes,bckWrites,maxBckWrites,failedBckWrites,invalidateReqs,invalidatedRanges,readTime,hitTime,missTime,prefetchTime,writeTime,bckWriteTime,readSize,writeSize,pendReads,pendPrefetches,pendWrites,pendBckWrites,pendStoreReads,pendStoreWrites,bckWritesLimit,pendInvalidates,dirtyBytes,cachedBytes,%,persistedInvalidates,pagesPinned,pagesUnpinned,failedPagePins.

Category `memcache`. Groups: concurrency,hitBytes,iops,throughput. Metrics: hitBytes,missBytes,prefetchBytes,missBlocks,missAfterLock,hitAfterLock,pMissAfterLock,pHitAfterLock,hitBlocks,prefetchBlocks,memPuts,pendPrefetches,pendPrefetchesFO.

Category `logstore`. Groups: concurrency,efficiency,iops,latency,throughput. Metrics: %hits,dataReadBytes,layoutReadBytes,totalWriteBytes,layoutWriteBytes,writes,dataReads,layoutHits,layoutMisses,schedWrites,activeWrites,pendComplWrites,getDataTime,WriteTime,writeActiveTime,writePendingTime.

Category `objectstore`. Groups: concurrency,iops,latency,throughput,total. Metrics: getBytes,putBytes,listEntries,schedGets,schedPuts,schedDels,schedLists,activeGets,activePuts,activeDels,activeLists,totalGetBytes,totalPutBytes,totalListEntries,gets,puts,dels,lists,getFails,putFails,delFails,listFails,getCanceled,putCanceled,getTime,putTime,delTime,listTime.

Category `keystore`. Groups: iops,latency. Metrics: commits,aborts,puts,dels,getiters,finds,getIterTime,commitTime.

Category `versionedKeystore`. Groups: concurrency,iops,latency. Metrics: commits,flushes,getiters,commitTime,getIterTime,flushTime,pendFlush.

Category `synchronizer`. Groups: iops,latency,throughput. Metrics: localFetches,remoteFetches,localApplies,remoteApplies,localFetchedKeys,remoteFetchedKeys,localAppliedKeys,remoteAppliedKeys,localFetchTime,remoteFetchTime,localApplyTime,remoteApplyTime.

Category `preloader`. Groups: concurrency,iops,throughput,total. Metrics: bytesFetched,fetches,files,dirs,totalBytes,totalFiles,totalDirs,pendFetches,activePreloaders.

Category `metastore`. Groups: concurrency,efficiency,iops,latency. Metrics: fetches/misses,prefetches,fetchedRanges,prefetchedRanges,fetchedKeys,prefetchedKeys,fetchedRangesTime,prefetchedRangesTime,hits,pushes,pulls,pushedKeys,pulledKeys,pushTime,pullTime,localUpdates,remoteUpdates,localUpdateKeys,remoteUpdateKeys,evictedKeys,evictedRanges,dbSize,cachedNotifies,allNotifies,GCCollectedKeys,GCProcessedKeys,GCCommits,BrokenSyncIndexKeys,exitAppLiveKeys,exitAppDeletedKeys,exitAppPuts,exitAppDels,exitIntPuts,exitIntDels,commits,flushes,getIters,commitTime,getIterTime,flushTime,pendFlush.

List pinned entries

Positional. The file/folder to be pinned. The path starts at the Filespace root, not the local file system root.

The file/folder to be unpinned. The path starts at the Filespace root, not the local file system root.

Add this option in combination with '--unset' to unpin all entries

Display prefetcher information

Turn the prefetcher on

Turn the prefetcher off

Advanced. Display profiling information

Advanced. Enable or disable profiling

Advanced. Show the profiling counters

Advanced. Show the profiling counters in JSON form (must be with "--show")

Advanced. Reset the profiling counters

Azure account name

Azure account key

An administrator's password is required to use rekey-azure

S3 access key

S3 secret key

An administrator's password is required to use rekey-s3

Required. New login token for the same service account

Windows only. Display information about the current state of the Lucid service

Windows only. Install Lucid as a service

Windows only. Uninstall Lucid as a service

Windows only. Stop Lucid service

Windows only. Start Lucid service. Once Lucid is running, use lucid link command to link to a file space. When running as a service the options passed to the Lucid link command will be securely persisted. On service restart these persisted options will be applied automatically.

Windows only. Check the status of the shell extension

Windows only. Show detailed logging

Windows only. Show output in JSON format

An administrator's password is required for creating and deleting snapshots

Display the list of existing snapshots

Create a snapshot with the specified name. Name format: a-z, A-Z, 0-9, '-_ ()'. Max length 40 chars

Delete the snapshot with the specified id

An administrator's password is required for creating and deleting snapshot schedules

Display the list of existing snapshot schedules

Create a snapshot schedule based on interval and retention options. Name format: a-z, A-Z, 0-9, '-_ ()'. Max length 40 chars

Delete the snapshot schedule with the specified name

Positional. Local time when the snapshot schedule starts and creates the first snapshot. E.g 1970-01-31T23:00. Default: now

Define interval at which to create snapshots (e.g. 1d). Interval units: m-minute; h-hour; d-day; w-week; mo-month; y-year

Number of snapshots to keep (e.g. retention 6 for interval 1d means keep the last 6 snapshots that are made daily). Snapshots that are exceeding retention count will be automatically deleted

Enable access to the object store

Disable access to the object store

Collect information about all lucid instances when creating the diagnostic report

Advanced. Keep the collected bundle after successful upload

Don't ask for user consent when uploading the diagnostic report (https://www.lucidlink.com/kb-support-bundle-lucidlink3)

Specify a proxy server to tunnel all communication. Use the following format: [protocol://][user:password@]proxyhost[:port]. Supported protocols: http.

Suspend metadata synchronization

Resume metadata synchronization

Pre-hydrate a file/folder in TeamCache. The path starts at the Filespace root, not the local file system root.

List pre-hydrations.

Turn on event tracing for the list of comma separated tracers

Turn off event tracing

Clear all messages from all channels

A maximum number of events per tracer

Dump the tracers for the list of comma separated tracers or all (default is all)

Dump the results to a file (default is lucid.etl)

Display current trace status.

Don't show unlinking progress

Advanced. Environment to check

Check for newer version available on our servers

Download latest version from our servers (if newer)

Set output in JSON format

Specify a proxy server to tunnel all communication. Use the following format: [protocol://][user:password@]proxyhost[:port]. Supported protocols: http.

Set output in JSON format