Please note, as of Filespace format 2.2 the legacy term “Shares” has been changed to “Permissions.”

Advanced client functionality can be scripted through Windows, macOS, and Linux clients via the command line and terminal.

Please reach out via a support ticket for additional guidance as we would be happy to provide pre-prepared scripting examples to fast track your development efforts.

Usage: lucid [general options] command [options]

General options:

--rest-endpoint endpoint      Specify the REST service ip:port
--id id                       Specify a daemon instance id. To see instance ids, use 'lucid list'.
--instance id                 Same as --id
--name fs                     Specify a Filespace name

Commands:

help                          Display argument help information
version                       Display version information
daemon                        Start the daemon/service in interactive mode
log                           Set or display the logging verbosity. Default: list all loggers.
exit                          Call the daemon to exit
info                          Display general information
log-config                    Additional logging configuration
config                        Set local or global scope filespace configurations
perf                          Periodically output performance metrics.
fscheck                       Run checks on the filesystem metadata
status                        Display information about the currently linked Filespace
link                          Link to a Filespace
unlink                        Unlink form the currently linked Filespace
mount                         Mount the Filespace to the OS
unmount                       Unmount the Filespace from the OS
cache                         Display cache information as well as control the cache
prefetcher                    Display information and control the prefetcher
pin                           Pin/unpin a folder/file locally (keep/remove a local copy)
lock                          Display file locking information
compression                   Display information and control protocol compression
sync                          Synchronize all of the data and metadata with the cloud
init-s3                       Initialize with S3 object store
init-azure                    Initialize with Azure blob store
rekey-s3                      Rekey S3 credentials
rekey-azure                   Rekey Azure credentials
password                      Change your password
update                        Auto-updater control
snapshot                      Snapshot management. To activate a snapshot, see the options of 'lucid link'. To schedule snapshots see 'lucid snapshot-schedule'.
snapshot-schedule             Snapshot schedule management - requires administrative privileges
user                          User management - requires administrative privileges
group                         Group management - requires administrative privileges
permission                    Permission management - requires administrative privileges (Filespace Format 2.2 and above) share Share management - requires administrative privileges (before Filespace Format 2.2)
latency                       Display a frequency distribution list of latencies or statistics for the GET or PUT requests.
support                       Collect and upload a Lucid diagnostic report
metastore                     Controls the behavior of the metastore.
list                          Lists the currently linked Filespaces
service                       Manage the Lucid service - requires Windows Administrator privileges

Examples:     

lucid version
lucid help status
lucid support

Change Filespace mount-point

Adjust local cache settings

Link Filespace from the command line

Link to multiple Filespaces on the same client