Skip to main content

Module probes

Module probes 

Source
Expand description

The environment probe catalog.

One catalog, read by every caller that needs to know whether this host is ready: rk doctor runs it whole, and a mutating command guards the subset it depends on at entry, so the per-command guards and the doctor cannot drift apart. Each probe answers with a status, a message, and — on failure — the remediation printed verbatim wherever the probe is consulted.

Structs§

ProbeResult
One probe’s answer.

Enums§

ProbeClass
How a failure weighs at the doctor level.
ProbeStatus
What a probe found.

Constants§

HARD_RUNTIME_TOOLS
Every executable a Hard probe requires, paired with the nixpkgs package whose bin/ supplies it in the installed package’s wrapper.
SKILL_PROBES
The probes judging the skill installation itself, in catalog order.

Functions§

direnv
direnv answers; it loads the devshell on directory entry.
direnv_bin
One owner for the direnv binary, which nothing here spawns but the doctor probes: it is what loads a consumer’s devshell on entry. RK_DIRENV_BIN substitutes it.
forge_bin
One owner for a forge CLI’s binary name, honoring the override that keeps the tests hermetic.
forge_cli_version
Run <bin> --version and parse it. A spawn failure, a non-zero exit, or output carrying no version run all answer None, because none of them proves a version this binary can trust.
git_bin
One owner for the git binary every production launcher spawns.
nix
Nix answers; rk devshell sync updates and builds the pinned devshell with it. Soft, and deliberately outside the wrapper: wrapping nix would put it inside the package’s own closure on every host.
nix_bin
One owner for the nix binary every devshell launch spawns: the lock refresh, the system probe, and the build. RK_NIX_BIN substitutes it.
parse_cli_version
The first <major>.<minor>.<patch> run in a version line.
require_forge_cli
The gate a verb runs before its first forge call: the CLI is present and at or above Forge::cli_floor. Returns the binary to spawn and the version found.
run_all
Run the whole catalog, in its stable order.
sh_bin
One owner for the POSIX shell every setup step spawns through.