Advanced client functionality can be scripted through Windows, macOS and Linux clients via the command line and terminal. Please reach out via support 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-port port         specify the REST service port

    --instance id              specify the daemon instance, when running multiple instances


    help                    display argument help information

    version               display version information

    daemon             start the daemon/service in interactive mode

    start                   start the daemon/service

    stop                   stop the daemon/service

    info                    display general information

    fscheck              Run checks on the filesystem metadata

    status                 display information about the currently linked file space

    log                     sets the logging verbosity

    log-config         additional logging configuration

    link                    link to a file space

    unlink                unlink form the currently linked file space

    mount               mount the file space to the OS

    unmount           unmount the file space from the OS

    activate             activate the currently linked file space

    deactivate         deactivate the active file space

    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 a folder/file locally (keep a local copy)*

    unpin               unpin a folder/file (remove the local copy)*

    is-pinned         check if a folder/file is currently pinned*

    compression    display information and control protocol compression

    sync                  synchronize all of the data and metadata with the cloud

    init-s3               initialize with Amazon S3 object store

    init-ram            initialize with in-memory (RAM) object store

    rekey-s3           rekey Amazon S3 credentials

    password         change the shared secret

    update             auto-updater control

    install               install Lucid as a service*

    uninstall           uninstall the Lucid service*



    1. Lucid version

    2. Lucid help status

*future development