LucidLink CLI Overview

The LucidLink command-line interface (lucid) links to filespaces, mounts them, and manages the local daemon. It is the scripting-friendly counterpart to the desktop app — useful for headless machines, containers, and automation.

The CLI covers Windows and macOS. Platform-specific commands and options are noted where availability differs — for example service and shell-ext are Windows-only, and mount-point options differ per OS.

Invocation & global options

Every invocation follows the same shape — global options come before the command name:

lucid [general options] <command> [options]

The most useful global options select which daemon or filespace a command targets:

Capability	Description
--name <fs>	Target a filespace by name.
--id <id> / --instance <id>	Target a specific daemon instance id (see lucid list). --instance is an alias for --id.
--rest-endpoint <ip:port>	Talk to the daemon at a specific REST endpoint. Mutually exclusive with --id / --instance / --name when a full endpoint is given.
--rest-timeout <seconds>	Advanced. Timeout for REST calls to the daemon. Default is 60.
--cli-loglevel <level>	Advanced. Log level for the CLI itself.

--name <fs>

Description: Target a filespace by name.

--id <id> / --instance <id>

Description: Target a specific daemon instance id (see lucid list). --instance is an alias for --id.

--rest-endpoint <ip:port>

Description: Talk to the daemon at a specific REST endpoint. Mutually exclusive with --id / --instance / --name when a full endpoint is given.

--rest-timeout <seconds>

Description: Advanced. Timeout for REST calls to the daemon. Default is 60.

--cli-loglevel <level>

Description: Advanced. Log level for the CLI itself.

Common commands

The CLI groups into a handful of areas. The tables below cover the commands you will reach for most; the command reference documents every command and option in full.

Linking, mounting & status

Capability	Description
link	Link to a filespace (and mount it unless --no-mount). Accepts credentials, a mount point, read-only/suspended modes, snapshot activation, and a proxy.
unlink	Unlink from the currently linked filespace.
mount / unmount	Mount the linked filespace to the OS (at a mount point / drive letter) or unmount it.
daemon	Start the daemon/service in interactive mode (foreground), optionally linking a filespace on start.
list	List the currently linked filespaces and their daemon instance ids (--json for machine output).
status / info	Show information about the currently linked filespace (status) or general daemon information (info).
exit	Ask the daemon to exit.

link

Description: Link to a filespace (and mount it unless --no-mount). Accepts credentials, a mount point, read-only/suspended modes, snapshot activation, and a proxy.

unlink

Description: Unlink from the currently linked filespace.

mount / unmount

Description: Mount the linked filespace to the OS (at a mount point / drive letter) or unmount it.

daemon

Description: Start the daemon/service in interactive mode (foreground), optionally linking a filespace on start.

list

Description: List the currently linked filespaces and their daemon instance ids (--json for machine output).

status / info

Description: Show information about the currently linked filespace (status) or general daemon information (info).

exit

Description: Ask the daemon to exit.

Cache & performance

Capability	Description
cache	Display cache information and control the data cache — turn it on/off, set its size, drop or re-pin pages.
prefetcher	Display prefetcher information and turn it on/off.
metastore	Display metadata cache information or clear it.
perf / latency	Periodically print performance metrics, or show a latency distribution/stats for GET/PUT and filesystem I/O.
compression	Display protocol compression statistics.

cache

Description: Display cache information and control the data cache — turn it on/off, set its size, drop or re-pin pages.

prefetcher

Description: Display prefetcher information and turn it on/off.

metastore

Description: Display metadata cache information or clear it.

perf / latency

Description: Periodically print performance metrics, or show a latency distribution/stats for GET/PUT and filesystem I/O.

compression

Description: Display protocol compression statistics.

Snapshots & data locality

Capability	Description
pin	Pin or unpin a file/folder locally so a copy is kept on this client (--list, --set, --unset, --all).
team-cache	Manage TeamCache pre-hydrations for a file/folder.
snapshot	Create, list, or delete snapshots. Activate one via lucid link --snapshot.
snapshot-schedule	Manage scheduled snapshots by interval and retention (admin privileges required).
sync	Synchronize data and metadata with the cloud; suspend/resume metadata sync.

Description: Pin or unpin a file/folder locally so a copy is kept on this client (--list, --set, --unset, --all).

team-cache

Description: Manage TeamCache pre-hydrations for a file/folder.

snapshot

Description: Create, list, or delete snapshots. Activate one via lucid link --snapshot.

snapshot-schedule

Description: Manage scheduled snapshots by interval and retention (admin privileges required).

sync

Description: Synchronize data and metadata with the cloud; suspend/resume metadata sync.

Configuration, security & storage

Capability	Description
config	Get and set local- or global-scope filespace configuration. --explain describes each key; see the note below on scopes.
rekey-s3 / rekey-azure	Rotate the object-store credentials (S3 access/secret keys, or Azure account key). Requires an admin password.
rotate-credentials	Rotate the service-account login token for the linked session without re-linking.
move-s3	Reconfigure the S3 object-store connection for the filespace (bucket, provider, endpoint, region). Read the KB article before use.
external-files	Link and inspect external files (LucidLink Connect) from the CLI. Requires an admin password.
lock	Display current file-locking information.

config

Description: Get and set local- or global-scope filespace configuration. --explain describes each key; see the note below on scopes.

rekey-s3 / rekey-azure

Description: Rotate the object-store credentials (S3 access/secret keys, or Azure account key). Requires an admin password.

rotate-credentials

Description: Rotate the service-account login token for the linked session without re-linking.

move-s3

Description: Reconfigure the S3 object-store connection for the filespace (bucket, provider, endpoint, region). Read the KB article before use.

external-files

Description: Link and inspect external files (LucidLink Connect) from the CLI. Requires an admin password.

lock

Description: Display current file-locking information.

Maintenance & diagnostics

Capability	Description
service (Windows)	Install, start, stop, or check the Lucid Windows service (requires Administrator).
shell-ext (Windows)	Inspect the Windows Explorer shell extension status.
support	Collect and upload a diagnostic report.
log / log-config / trace	Control logging verbosity, logging format, and event tracing for troubleshooting.
fscheck	Run integrity checks on filesystem metadata.
update / version	Check for and download client updates, or display version information.

service (Windows)

Description: Install, start, stop, or check the Lucid Windows service (requires Administrator).

shell-ext (Windows)

Description: Inspect the Windows Explorer shell extension status.

support

Description: Collect and upload a diagnostic report.

log / log-config / trace

Description: Control logging verbosity, logging format, and event tracing for troubleshooting.

fscheck

Description: Run integrity checks on filesystem metadata.

update / version

Description: Check for and download client updates, or display version information.

A note on configuration scope. lucid config settings apply either --local (this client only) or --global (every client that connects to the filespace, unless overridden locally). Use --explain to describe a key and its constraints, and --list to show current values per scope.

Quickstart

A typical session links a filespace, works with it through the mounted filesystem, and unlinks when finished:

# Link a filespace and mount itlucid link --fs my-filespace \  --user me@example.com --password '••••••' \  --mount-point /Volumes/my-filespace
# See what is linked, then check statuslucid listlucid status
# Unlink when donelucid unlink

On headless hosts you can run the daemon in the foreground with lucid daemon --fs my-filespace, and on Windows you can persist a link across restarts by running Lucid as a service (lucid service --install, then lucid link).

Full command reference

For every command, option, and configuration key — including advanced and platform-specific flags — see the CLI command reference.