Skip to content
Workloom
Menu

CLI command · Home workspace

wl install

Add a package to the home workspace and sync it.

Pins the package ref in the home workspace manifest, then syncs: owned files are written, settings effects applied and secret references resolved locally. Plugin refs install only if their id is on your approved-plugins allowlist; --approve-plugin adds them.

Usage

wl install <package> [options]

Arguments and options

<package>
Package ref: name or name@version.
--workspace <path>
Target workspace manifest. Default: the home workspace ($WORKLOOM_HOME_WORKSPACE, then ~/.workloom/home.workspace.json).
--adopt
Back up and take ownership of pre-existing files Workloom does not own.
--approve-local
Record an eligible local approval.
--approve-plugin
Approve any plugin ref the package registers (adds it to the allowlist).