This example demonstrates the Glazed config-plan API in a small runnable program.

It shows how to:

• declare a layered config plan
• resolve repo, cwd, and explicit config files in low → high precedence order
• print a human-readable plan report
• load the resolved files with sources.FromResolvedFiles(...)
• understand when you could swap that for sources.FromConfigPlan(...)
• inspect the resulting parsed field history and config provenance metadata

Run the example

cd cmd/examples/config-plan

go run . show

This resolves:

• repo.yaml from the repository root via GitRootFile(...)
• local.yaml from the current working directory via WorkingDirFile(...)

Then it prints:

1. the resolved plan report
2. the final decoded settings
3. the parsed field history including config metadata

Add an explicit override

cd cmd/examples/config-plan

go run . show --explicit explicit.yaml

The explicit file is applied last, so it overrides both the repo-level and cwd-level files.

Why this example uses FromResolvedFiles(...)

This runnable example resolves the plan explicitly first because it wants to print the plan report before loading values.

If your application does not need to inspect or print report.String() and only wants the resolved settings, the loading step can be shortened to:

sources.Execute(schema_, parsed, sources.FromConfigPlan(plan))

That direct middleware form still preserves the same config provenance metadata in parsed field history.

What to inspect

The most important part of the output is the parsed field history. Config-derived writes will include metadata like:

• config_file
• config_index
• config_layer
• config_source_name
• config_source_kind

That makes it easy to explain exactly why a final value won.

Source files

See:

• cmd/examples/config-plan/main.go
• cmd/examples/config-plan/repo.yaml
• cmd/examples/config-plan/local.yaml
• cmd/examples/config-plan/explicit.yaml
• cmd/examples/config-plan/README.md

See Also

• Declarative Config Plans
• Config Files and Overlays