brun

package module

Go to main page

Versions in this module

v0

v0.0.20

Dec 30, 2025

Changes in this version

+ type NtfyConfig struct

+ IncludeOutput *bool

+ LimitLines int

+ Priority string

+ Server string

+ Tags string

+ TitlePrefix string

+ Topic string

+ type NtfyUnit struct

+ func NewNtfyUnit(name, topic, server, titlePrefix, priority, tags string, includeOutput bool, ...) *NtfyUnit

+ func (n *NtfyUnit) Always() []string

+ func (n *NtfyUnit) Name() string

+ func (n *NtfyUnit) OnFailure() []string

+ func (n *NtfyUnit) OnSuccess() []string

+ func (n *NtfyUnit) Run(ctx context.Context) error

+ func (n *NtfyUnit) SetOutput(output string)

+ func (n *NtfyUnit) SetTriggerError(err error)

+ func (n *NtfyUnit) SetTriggeringUnit(unitName string)

+ func (n *NtfyUnit) Type() string

type UnitConfigWrapper

+ Ntfy *NtfyConfig

v0.0.19

Dec 12, 2025

v0.0.18

Nov 8, 2025

v0.0.17

Nov 6, 2025

Changes in this version

+ type CheckMode int

+ const CheckModeManual

+ const CheckModePolling

+ func (m CheckMode) String() string

v0.0.16

Nov 5, 2025

v0.0.15

Oct 15, 2025

v0.0.14

Oct 15, 2025

v0.0.13

Oct 15, 2025

v0.0.12

Oct 14, 2025

v0.0.11

Oct 13, 2025

v0.0.10

Oct 13, 2025

v0.0.9

Oct 8, 2025

Changes in this version

type Orchestrator

+ func (o *Orchestrator) GetActiveUnit() string

+ func (o *Orchestrator) RunOnce(ctx context.Context) error

+ func (o *Orchestrator) SetDaemonMode(daemon bool)

+ func (o *Orchestrator) Stop(error)

v0.0.8

Oct 8, 2025

v0.0.7

Oct 7, 2025

Changes in this version

type GitConfig

+ Debug bool

+ Poll string

v0.0.6

Oct 7, 2025

Changes in this version

type EmailConfig

+ LimitLines int

type GitConfig

+ Branch string

+ Reset bool

v0.0.5

Oct 7, 2025

Changes in this version

+ func Update(currentVersion string) error

+ type GitHubRelease struct

+ Name string

+ TagName string

type RunConfig

+ Shell string

+ UsePTY bool

v0.0.4

Oct 6, 2025

v0.0.3

Oct 6, 2025

v0.0.2

Oct 6, 2025

v0.0.1

Oct 6, 2025

Changes in this version

+ func Install() error

+ type BootConfig struct

+ type BootDetector struct

+ func NewBootDetector(stateFile string) *BootDetector

+ func (bd *BootDetector) GetBootTime() (time.Time, error)

+ func (bd *BootDetector) IsFirstRunSinceBoot() (bool, error)

+ type BootTrigger struct

+ func NewBootTrigger(name string, state *State, onSuccess, onFailure, always []string) *BootTrigger

+ func (s *BootTrigger) Always() []string

+ func (s *BootTrigger) Check(ctx context.Context) (bool, error)

+ func (s *BootTrigger) Name() string

+ func (s *BootTrigger) OnFailure() []string

+ func (s *BootTrigger) OnSuccess() []string

+ func (s *BootTrigger) Run(ctx context.Context) error

+ func (s *BootTrigger) Type() string

+ type Config struct

+ ConfigBlock ConfigBlock

+ Units []UnitConfigWrapper

+ func LoadConfig(path string) (*Config, error)

+ func (c *Config) CreateUnits() ([]Unit, error)

+ type ConfigBlock struct

+ StateLocation string

+ type CountConfig struct

+ type CountUnit struct

+ func NewCountUnit(name string, state *State, onSuccess, onFailure, always []string) *CountUnit

+ func (c *CountUnit) Always() []string

+ func (c *CountUnit) Name() string

+ func (c *CountUnit) OnFailure() []string

+ func (c *CountUnit) OnSuccess() []string

+ func (c *CountUnit) Run(ctx context.Context) error

+ func (c *CountUnit) SetTriggeringUnit(unitName string)

+ func (c *CountUnit) Type() string

+ type CronConfig struct

+ Schedule string

+ type CronTrigger struct

+ func NewCronTrigger(name, schedule string, state *State, onSuccess, onFailure, always []string) *CronTrigger

+ func (c *CronTrigger) Always() []string

+ func (c *CronTrigger) Check(ctx context.Context) (bool, error)

+ func (c *CronTrigger) Name() string

+ func (c *CronTrigger) OnFailure() []string

+ func (c *CronTrigger) OnSuccess() []string

+ func (c *CronTrigger) Run(ctx context.Context) error

+ func (c *CronTrigger) Type() string

+ type EmailConfig struct

+ From string

+ IncludeOutput *bool

+ SMTPHost string

+ SMTPPassword string

+ SMTPPort int

+ SMTPUseTLS *bool

+ SMTPUser string

+ SubjectPrefix string

+ To []string

+ type EmailUnit struct

+ func NewEmailUnit(name string, to []string, from, subjectPrefix, smtpHost string, smtpPort int, ...) *EmailUnit

+ func (e *EmailUnit) Always() []string

+ func (e *EmailUnit) Name() string

+ func (e *EmailUnit) OnFailure() []string

+ func (e *EmailUnit) OnSuccess() []string

+ func (e *EmailUnit) Run(ctx context.Context) error

+ func (e *EmailUnit) SetOutput(output string)

+ func (e *EmailUnit) SetTriggerError(err error)

+ func (e *EmailUnit) SetTriggeringUnit(unitName string)

+ func (e *EmailUnit) Type() string

+ type FileConfig struct

+ Pattern string

+ type FileTrigger struct

+ func NewFileTrigger(name, pattern string, state *State, onSuccess, onFailure, always []string) *FileTrigger

+ func (f *FileTrigger) Always() []string

+ func (f *FileTrigger) Check(ctx context.Context) (bool, error)

+ func (f *FileTrigger) Name() string

+ func (f *FileTrigger) OnFailure() []string

+ func (f *FileTrigger) OnSuccess() []string

+ func (f *FileTrigger) Run(ctx context.Context) error

+ func (f *FileTrigger) Type() string

+ type GitConfig struct

+ Repository string

+ type GitTrigger struct

+ func NewGitTrigger(name, repository string, state *State, onSuccess, onFailure, always []string) *GitTrigger

+ func (g *GitTrigger) Always() []string

+ func (g *GitTrigger) Check(ctx context.Context) (bool, error)

+ func (g *GitTrigger) Name() string

+ func (g *GitTrigger) OnFailure() []string

+ func (g *GitTrigger) OnSuccess() []string

+ func (g *GitTrigger) Run(ctx context.Context) error

+ func (g *GitTrigger) Type() string

+ type LogConfig struct

+ File string

+ type LogUnit struct

+ func NewLogUnit(name, file string, onSuccess, onFailure, always []string) *LogUnit

+ func (l *LogUnit) Always() []string

+ func (l *LogUnit) Name() string

+ func (l *LogUnit) OnFailure() []string

+ func (l *LogUnit) OnSuccess() []string

+ func (l *LogUnit) Run(ctx context.Context) error

+ func (l *LogUnit) SetOutput(output string)

+ func (l *LogUnit) SetTriggeringUnit(unitName string)

+ func (l *LogUnit) Type() string

+ type Orchestrator struct

+ func NewOrchestrator(units []Unit) *Orchestrator

+ func (o *Orchestrator) GetResults() map[string]*UnitResult

+ func (o *Orchestrator) Run(ctx context.Context) error

+ func (o *Orchestrator) RunDaemon(ctx context.Context) error

+ func (o *Orchestrator) RunSingleUnit(ctx context.Context, unitName string, runTriggers bool) error

+ type RebootConfig struct

+ Delay int

+ type RebootUnit struct

+ func NewRebootUnit(name string, delay int, onSuccess, onFailure, always []string) *RebootUnit

+ func (r *RebootUnit) Always() []string

+ func (r *RebootUnit) Name() string

+ func (r *RebootUnit) OnFailure() []string

+ func (r *RebootUnit) OnSuccess() []string

+ func (r *RebootUnit) Run(ctx context.Context) error

+ func (r *RebootUnit) Type() string

+ type RunConfig struct

+ Directory string

+ Script string

+ Timeout string

+ type RunUnit struct

+ func NewRunUnit(name, script, directory string, timeout time.Duration, ...) *RunUnit

+ func (r *RunUnit) Always() []string

+ func (r *RunUnit) Name() string

+ func (r *RunUnit) OnFailure() []string

+ func (r *RunUnit) OnSuccess() []string

+ func (r *RunUnit) Run(ctx context.Context) error

+ func (r *RunUnit) Type() string

+ type StartConfig struct

+ type StartTrigger struct

+ func NewStartTrigger(name string, onSuccess, onFailure, always []string) *StartTrigger

+ func (s *StartTrigger) Always() []string

+ func (s *StartTrigger) Check(ctx context.Context) (bool, error)

+ func (s *StartTrigger) Name() string

+ func (s *StartTrigger) OnFailure() []string

+ func (s *StartTrigger) OnSuccess() []string

+ func (s *StartTrigger) Run(ctx context.Context) error

+ func (s *StartTrigger) Type() string

+ type State struct

+ func NewState(filePath string) *State

+ func (s *State) Get(unitName, key string) (any, bool)

+ func (s *State) GetString(unitName, key string) (string, bool)

+ func (s *State) Load() error

+ func (s *State) Save() error

+ func (s *State) Set(unitName, key string, value any) error

+ func (s *State) SetString(unitName, key, value string) error

+ type TriggerUnit interface

+ Always func() []string

+ Check func(ctx context.Context) (bool, error)

+ OnFailure func() []string

+ OnSuccess func() []string

+ type Unit interface

+ Name func() string

+ Run func(ctx context.Context) error

+ Type func() string

+ type UnitConfig struct

+ Always []string

+ Name string

+ OnFailure []string

+ OnSuccess []string

+ Type string

+ type UnitConfigWrapper struct

+ Boot *BootConfig

+ Count *CountConfig

+ Cron *CronConfig

+ Email *EmailConfig

+ File *FileConfig

+ Git *GitConfig

+ Log *LogConfig

+ Reboot *RebootConfig

+ Run *RunConfig

+ Start *StartConfig

+ type UnitResult struct

+ Error error

+ Output string

+ Unit Unit

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL