Command-line feature functions

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
    --instance id            Specify the daemon instance, when running multiple instances

Commands:    
    help                     Display argument help information
    version                  Display version information
    daemon                   Start the daemon/service in interactive mode
    info                     Display general information
    fscheck                  Run checks on the filesystem metadata
    status                   Display information about the currently linked filespace
    log                      Sets the logging verbosity
    log-config               Additional logging configuration
    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
    exit                     Call the daemon to exit
    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. 
    snapshot-schedule        Snapshot schedule management - requires root permissions
    user                     User management - requires root permissions
    group                    Group management - requires root permissions
    share                    Share management - requires root permissions
    config                   Set local or global scope filespace configurations
    perf                     Periodically output performance metrics.
    latency                  Display a frequency distribution list of latencies or statistics for the GET or PUT requests.
    support                  Collect and upload a Lucid diagnostic report
    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