mode

package

v1.6.1 Latest Latest Go to latest Published: Apr 6, 2026 License: MIT Imports: 3 Imported by: 0

Details

Package mode is an abstraction for executing the various "modes" supported by Ferrite.

This section is empty.

This section is empty.

func ResetDefaultConfig()

ResetDefaultConfig resets DefaultConfig to its initial value. This is largely intended for tearing down tests.

type Config struct {
	Registries variable.RegistrySet
	Args       []string
	Out        io.Writer
	Err        io.Writer
	Exit       func(int)
}

Config is the configuration used when running a mode.

var DefaultConfig Config

DefaultConfig is the default configuration for running a mode.

Path	Synopsis
export
dotenv Package dotenv is a Ferrite mode that exports the environment variables to a file suitable use as a .env file.	Package dotenv is a Ferrite mode that exports the environment variables to a file suitable use as a .env file.
internal
render Package render contains utilities for rendering variable values and schema descriptions in a consistent way across various modes.	Package render contains utilities for rendering variable values and schema descriptions in a consistent way across various modes.
usage
markdown Package markdown is a Ferrite mode that generates usage documentation in markdown format.	Package markdown is a Ferrite mode that generates usage documentation in markdown format.
validate Package validate is a Ferrite mode that validates environment variable values against a set of specifications and exits the process if any are invalid.	Package validate is a Ferrite mode that validates environment variable values against a set of specifications and exits the process if any are invalid.