All docs
PackageManager·
method
PackageManager.install
install a package from a local directory, .zip, or .lsdpkg
Python
install(source: str) -> Optional[PackageInfo]
Returns PackageInfo — the installed package, or None on failure
Parameters#
| name | type | default | description |
|---|---|---|---|
source |
str |
— | path to a package directory, a .zip, or a sealed .lsdpkg archive |
Example#
Python
from lsdtools.advanced import PackageManager
pm = PackageManager()
pm.install("./my-pkg") # a folder
pm.install("./mim-1.2.0.zip") # a zip archive
Notes#
Dispatches on source: a .lsdpkg is verified and stored sealed, a .zip is extracted (the
shallowest lsd_package.json inside wins, so a GitHub archive with a nested package folder works),
and a directory is copied whole. In every case the package is copied into ~/.lsd/packages/ and
added to the installed record — use add_local to register a
folder by reference instead. Returns None when source is not a directory, .zip, or .lsdpkg.
See also#
API: install_url · add_local · remove
Guides: Install from the store · The Package Manager
By LSD Team · Last updated Jul 17, 2026
Ask on Discord
View as Markdown