config

Documentation

Index

• Constants
• type Command
• type Config
  • func Load(projectDir, globalPath string) (Config, error)
  • func LoadDefault() (Config, error)
• type ServiceConfig
  • func (s *ServiceConfig) UnmarshalYAML(unmarshal func(any) error) error
• type Traefik

Constants

const (
	DefaultComposeCommand = "docker compose"
	DefaultRuntimeCommand = "docker"
	DefaultTraefikPort    = 80
)

Types

type Command

type Command struct {
	Compose string `yaml:"compose"`
	Runtime string `yaml:"runtime"`
}

type Config

type Config struct {
	Command  Command                  `yaml:"command"`
	Traefik  Traefik                  `yaml:"traefik"`
	Services map[string]ServiceConfig `yaml:"services"`
}

func Load

func Load(projectDir, globalPath string) (Config, error)

Load reads config from .tug.yaml in projectDir (project-local) and globalPath (global), merging with project-local taking priority over global. Both files are optional; missing files are silently ignored.

func LoadDefault

func LoadDefault() (Config, error)

LoadDefault loads config using the current directory and the standard global config path (~/.config/tug.yaml).

type ServiceConfig

type ServiceConfig struct {
	Kind  string            `yaml:"kind"`  // default kind: "http" or "tcp"
	Ports map[uint16]string `yaml:"ports"` // per-port kind override: containerPort → "http" | "tcp"
}

ServiceConfig holds per-service overrides.

func (*ServiceConfig) UnmarshalYAML

func (s *ServiceConfig) UnmarshalYAML(unmarshal func(any) error) error

type Traefik

type Traefik struct {
	Port      uint16 `yaml:"port"`
	Dashboard bool   `yaml:"dashboard"`
}

Traefik holds configuration for the Traefik reverse proxy.