LucidLink CLI Reference
The LucidLink command-line interface for linking to filespaces, mounting, and managing the local daemon.
Covers Windows, Linux, macOS. Platform-specific commands and options are noted where availability differs.
lucid [general options] <command> [options]Global options
Options that apply to every command. Pass them before the command name.
Option | Description |
|---|---|
| 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 |
[--rest-endpoint
Description
Specify the REST service ip:port. Mutually exclusive with --id, --instance, and --name if a full REST endpoint, including port, is specified
[--id
Description
Specify a daemon instance id. To see instance ids, use 'lucid list'.
[--instance
Description
Same as --id
[--name
Description
Specify a Filespace name
Commands
Every command has its own page with the full usage synopsis and options.
lucid cache — Display cache information as well as control the cache
lucid compression — Display information and control protocol compression
lucid config — Set local or global scope filespace configurations
lucid daemon — Start the daemon/service in interactive mode
lucid exit — Call the daemon to exit
lucid external-files — Manage external files - requires administrative privileges
lucid fscheck — Run checks on the filesystem metadata
lucid help — Display argument help information
lucid info — Display general information
lucid latency — Display a frequency distribution list of latencies or statistics for the GET or PUT requests.
lucid link — Link to a Filespace
lucid list — Lists the currently linked Filespaces
lucid lock — Display file locking information
lucid log — Set or display the logging verbosity. Default: list all loggers.
lucid log-config — Additional logging configuration
lucid metastore — Controls the behavior of the metastore.
lucid mount — Mount the Filespace to the OS
lucid perf — Periodically output performance metrics.
lucid pin — Pin/unpin a folder/file locally (keep/remove a local copy)
lucid prefetcher — Display information and control the prefetcher
lucid rekey-azure — Rekey Azure credentials
lucid rekey-s3 — Rekey S3 credentials
lucid rotate-credentials — Rotate credentials for the linked session without re-linking
lucid service — Windows only. Manage the Lucid service - requires Windows Administrator privileges
lucid shell-ext — Windows only. Get information about the Windows Explorer shell extension
lucid snapshot — Snapshot management. To activate a snapshot, see the options of 'lucid link'.
lucid snapshot-schedule — Snapshot schedule management - requires administrative privileges
lucid status — Display information about the currently linked Filespace
lucid support — Collect and upload a Lucid diagnostic report
lucid sync — Synchronize all of the data and metadata with the cloud
lucid team-cache — Manage TeamCache pre-hydrations
lucid unlink — Unlink from a linked filespace.
lucid unmount — Unmount the Filespace from the OS
lucid update — Auto-updater control
lucid version — Display version information