Skip to main content

Module drift

Module drift 

Source
Expand description

HELIX Drift: how a machine has moved away from a saved baseline or a workstation profile. A baseline records what was installed, the configuration files catalog entries write (by checksum, never their contents), a few machine settings and the entries HelixForge ran there. Comparing names what is missing, changed or new, and which entry would put a missing part back; nothing here changes the machine.

Structs§

Applied
An entry that ran, and when (Unix seconds).
Baseline
A saved state of a machine.
Difference
One difference.
FileRecord
One configuration path as it was.
Recorded
An installed entry: its id, and where from and which version.
Report
What a comparison found.
Sources
Everything a capture or a comparison reads; tests supply their own.

Enums§

BaselineError
Why a baseline cannot be used.
FileKind
Kind
What kind of difference.

Constants§

FORMAT
The baseline file format this version writes.

Functions§

capture
Record this machine as a baseline. extra adds paths of the user’s own to the configuration files the catalog’s entries write.
check
Plain text throughout, ids that are ids and paths HelixForge compares: a shared file could otherwise carry escape sequences into the terminal.
compare
Compare the machine with a baseline.
compare_profile
Compare the machine with a profile: whether each entry it names is installed, its files are there, or HelixForge has run it here.
dir
$XDG_CONFIG_HOME/helixforge/baselines, or under ~/.config.
find
Find a saved baseline by its name or slug.
load_all
The baselines in directory, newest first, each with its slug; files that cannot be used are returned as problems.
read
Read and check a baseline file.
save
Save a baseline in directory under its name’s slug, replacing one of the same name. Returns the file.
settings_here
The settings a baseline records, read from this machine.
valid_path
Whether a path is one a baseline may name.
write
Write a baseline to a file, whole or not at all.