genconfig

package
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 24, 2025 License: MIT Imports: 5 Imported by: 1

Documentation

Overview

Package genconfig provides functionality to auto-generate a sample YAML configuration file (`config.yaml.sample`) from a Go struct using struct tags.

Index

Constants

This section is empty.

Variables

View Source 
var SampleFileName = "config.yaml.sample"

SampleFileName defines the default name for the generated sample config file.

Functions

func GenConfig 

func GenConfig(cfg any)

GenConfig generates a sample config file from the given struct. The struct fields must be tagged with `yaml`, and optionally `default`, `comment`, and `required`.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.