API Reference

LucidLink Python Library

Python bindings for LucidLink Core C++ daemon library. Provides programmatic access to LucidLink filespaces from Python.

See the Quick Start for usage examples.

lucidlink.create_daemon(config: Dict[str, str] | None = None, sandboxed: bool = True, persist_files: bool = False, root_path: str | Path | None = None) → Daemon[source]

Create a Daemon with simplified storage configuration.

This is a convenience factory that makes it easier to configure daemon storage without needing to manually create StorageConfig objects.

Parameters:

config – Additional daemon configuration options (cache size, etc.)
sandboxed – If True (default), use temp directory that’s always cleaned up. If False, use .lucid subfolder in current directory.
persist_files – If False (default), clean up files when daemon stops. Only applies when sandboxed=False. Sandboxed mode always cleans up.
root_path – Override root path for files (only when sandboxed=False). If None, uses current working directory.

Returns:

Daemon instance with specified storage configuration

Example

# Sandboxed (default) - files in temp, always cleaned up
daemon = lucidlink.create_daemon()

# Physical with cleanup - files in .lucid/, cleaned up on exit
daemon = lucidlink.create_daemon(sandboxed=False)

# Physical with persistence - files in .lucid/, kept after exit
daemon = lucidlink.create_daemon(sandboxed=False, persist_files=True)

# Custom root path
daemon = lucidlink.create_daemon(
    sandboxed=False,
    root_path="D:/lucid_data",
)

# With custom config
daemon = lucidlink.create_daemon(
    config={"fs.cache.size": "2048"},
    sandboxed=False,
    persist_files=True,
)