All docs
API Reference
Runtime
Runtime describes an installed LSD product — its install dir, CLI, GUI, and Python paths. Reference for find_runtime and the API_VERSION constant.
You author against lsdtools in any local Python, but packages run inside the installed LSD
product — the MSI-installed runtime (or a dev build), which carries the pacman-built pyarrow,
numpy, and GTK your packages need. find_runtime() discovers that install and returns a Runtime
describing it: its install dir, the CLI and GUI launchers, and the bundled interpreter. API_VERSION
reports the public API version your package was built against.
Usage#
Python
from lsdtools import find_runtime, API_VERSION
rt = find_runtime()
print(rt.cli, API_VERSION)
# → C:\Program Files\LSD Desktop\LSDCli.exe 1.0
Where to start#
Learn — Install LSD
API — Engine · CLI commands · lsdtools API reference
Properties
- API_VERSION the public lsdtools API version string ("1.0")
- cli path to LSDCli.exe, the console client for running packages headlessly, or None
- executable the preferred entry point to run — the CLI if present, else the GUI
- gui path to LSDDesktop.exe, the desktop launcher, or None
- install_dir the directory the LSD product is installed in
- python path to the product's bundled Python interpreter, or None
- source how the install was found — env, registry, well-known, or path
Functions
- find_runtime locate the installed LSD runtime, or return None
By LSD Team · Last updated Jul 17, 2026
Ask on Discord
View as Markdown