Skip to main content

install

Function install 

Source
pub fn install(
    layout: &Layout,
    apply: bool,
    force: bool,
) -> Result<Vec<Action>, RkError>
Expand description

Install every embedded skill under each root, previewing by default.

record_path names the user-scope digest record: read to tell a stale copy this tool wrote from a file the user edited, and rewritten after a successful apply. Failing to write it is not a failure of the install — the files landed — so it costs only the benefit of the doubt next time.

§Errors

Returns RkError::Refused when the shared root is reached through a symlink, when a destination cannot be touched, when one holds bytes neither reference accounts for and force is unset, or when a write fails partway, in which case the destinations are restored first. Returns RkError::Io when a destination exists but cannot be read.