Skip to main content

Module config

Module config 

Source
Expand description

.krypt.toml configuration schema and parser.

See the project README for the full schema reference. This module defines the in-memory Rust shape of the config (Config and friends) and a parser that turns a .krypt.toml file or string into one of these structs.

What this module does not do (delegated to sibling modules):

The parser here treats ${VAR} strings as opaque text. Resolving them is a separate pass once the platform and overrides are known.

Structs§

Command
[[command]] entry — a custom user subcommand built from step primitives.
Config
Top-level parsed config.
DepsGroup
[[deps]] entry — one cross-distro dependency group.
Hook
[[hook]] entry — a lifecycle hook tied to a phase.
Link
[[link]] entry — a file (or glob) to deploy from the repo to a path under $HOME.
Meta
[meta] section.
PromptField
A single field inside a PromptSection.
PromptSection
[prompts.<name>] section — an interactive wizard subsection.
Step
One step inside a Command or Hook.
Template
[[template]] entry — a file copied like a [[link]], but with prompt- section names that wire it to krypt setup.

Enums§

ConfigError
Errors that can come out of parsing or validating a .krypt.toml.

Functions§

parse_file
Parse a .krypt.toml from disk.
parse_str
Parse from an in-memory string. Useful for tests and include expansion where we already have the bytes. path_hint shows up in error messages when the source isn’t an on-disk file.