Skip to main content

Module install

Module install 

Source
Expand description

Explicit, user-local installation. Install/uninstall without yes are read-only previews. yes authorizes payload/templates, not implicit edits to shell or tmux user configuration. Each user integration requires its own explicit configuration path; omitted integrations are retained on reinstall, except exact owned references migrated to a new layout. Run an extracted binary’s install --yes directly, rather than placing an unowned regular file at the managed bin-symlink destination first. Updates accept local native executables only; no downloads or version probes are performed.

Structs§

InstallOptions

Functions§

install
Print a plan and return without creating even a lock file unless options.yes is true. Reinstall retains unselected integrations, except exact owned references that must move with the generated scripts during a layout migration.
rollback
shell_quote
POSIX shell word quoting, also usable by other integration modules.
uninstall
Remove only manifest-owned, unmodified content. Never terminate tmux or shell sessions. This filesystem-only entry point does not restore live tmux bindings. CLI callers should use uninstall_with_hook to restore runtime-owned bindings before removal.
uninstall_with_hook
Preview the file-removal plan, then restore runtime integration before removing files. The hook runs once, under the installer lock, only with yes and an existing manifest, after file checks but before any planned removal. An error aborts removal and keeps installed files. The hook must not reenter the installer or terminate user sessions; restore only bindings whose exact ownership the runtime can verify.
update
Activate a checksum-verified local executable. Never execute the supplied file to inspect it.