Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

config

package

Go to main page

Versions in this module

v1

v1.1.1

Mar 7, 2026

v1.1.0

Dec 15, 2025

Changes in this version

+ const IncludePrefix

type Preset

+ IsHidden bool

type ToolConfig

+ func (t *ToolConfig) ResolveIncludesForPreset(presetName, toolNameAs string) (args []string, errs []error)

v1.0.1

Dec 6, 2025

v1.0.0

Jun 23, 2025

Changes in this version

+ func CreateDefaultConfig(path string) (err error)

+ func FindExecutablePath(executableName string, toolPlatform []string) (path string, ok bool)

+ func GetDefaultConfigStr() string

+ func GetOrCreateUserConfigFile(warnLog *log.Logger) (path string, created bool, err error)

+ func QueryPreset(presets map[string]Preset, name string) (preset string, isShorthand bool)

+ func QueryWrapper(wrappers map[string]string, toolPlatform []string, currentPlatform string) (wrapper string)

+ type CompressionTool struct

+ Command string

+ OutputMode OutputMode

+ Platform []string

+ SupportedFormats []string

+ func (ct *CompressionTool) CanBatchCompress() bool

+ func (ct *CompressionTool) Overwrites() bool

+ type Config struct

+ DefaultPreset string

+ MimeExtensions map[string][]string

+ Presets map[string]Preset

+ Tools map[string]*ToolConfig

+ Wrappers map[string]map[string]string

+ func DecodeConfigFile(path string) (cfg *Config, err error)

+ func (cfg *Config) Cache()

+ func (cfg *Config) GetSupportedFileExtensions() (fileExtMap map[string][]string)

+ func (cfg *Config) GetSupportedFileFormats() (fileFormatsMime []string)

+ func (cfg *Config) GetToolConfigFromNames(toolNames []string) (toolCfgMap map[string]*ToolConfig)

+ func (cfg *Config) HasAvailableTools() bool

+ func (cfg *Config) IsToolAvailable(toolName string) bool

+ func (cfg *Config) QueryToolWrapper(tool *ToolConfig, platform string) string

+ func (cfg *Config) Validate() []error

+ type OutputMode int

+ const BatchOverwrite

+ const InputOutput

+ const Stdout

+ const Unknown

+ func (o *OutputMode) UnmarshalYAML(value *yaml.Node) error

+ func (o OutputMode) MarshalYAML() (any, error)

+ type Preset struct

+ DefaultTools map[string][]string

+ Description string

+ Shorthands []string

+ type ToolConfig struct

+ Arguments map[string][]string

+ Description string