gorun

Nov 5, 2026

Changes in this version

+ func SaveChanges(changes []Change) error

type Bundle

+ Source string

+ type Change struct

+ Body map[string]any

+ File string

+ Kind string

+ Name string

+ Remove bool

type Config

+ Files []string

+ Path string

+ func (c *Config) LoadFile(path string) error

type Server

+ Source string

type ServerErrorEvent

+ func (e ServerErrorEvent) MarshalJSON() ([]byte, error)

type ServerGroup

+ Source string

type Task

+ Source string

type TaskEvent

+ func (e TaskEvent) MarshalJSON() ([]byte, error)

Nov 4, 2026

Changes in this version

type PlanEvent

+ EnvVars map[string]string

+ Vars map[string]any

type ProcessStartedEvent

+ EnvVars map[string]string

+ Vars map[string]any

type TaskEvent

+ EnvVars map[string]string

+ Vars map[string]any

Nov 4, 2026

Changes in this version

+ var ErrNoTasks = errors.New(...)

Nov 3, 2026

Changes in this version

+ func EnvLine(vars map[string]string) (string, error)

+ func ExpandEnv(value string) string

Nov 3, 2026

Changes in this version

type Bundle

+ Vars map[string]any

type Config

+ Vars map[string]any

type Server

+ Vars map[string]any

type ServerGroup

+ Vars map[string]any

type Task

+ Vars map[string]any

Nov 2, 2026

Changes in this version

+ var LocalServer = Server

type Config

+ func (c *Config) AllServers() []Server

+ func (c *Config) LocalServer() Server

+ func (c *Config) RunLocal(ctx context.Context, names ...string) error

type Server

+ func (s Server) IsLocal() bool

type Task

+ Local bool

type TaskExec

+ func NewLocalTaskExec(task ...Task) ([]*TaskExec, error)

Oct 31, 2026

Changes in this version

type Config

+ MaxTaskParallel int

type Server

+ MaxTaskParallel int

Oct 30, 2026

Changes in this version

+ const BundlePrefix

+ const DefaultRetryDelay

+ const DefaultTaskTimeout

+ const RerunSafe

+ const RerunUnsafe

+ func CopyFiles(client *ssh.Client, server any, task *Task) error

+ func LogFilePath() string

+ func LogOutput() io.Writer

+ func NewLogger(level string, w io.Writer, json bool) *slog.Logger

+ func NewSSHClient(ctx context.Context, server Server) (*ssh.Client, error)

+ func OpenLogFile(path string) (*os.File, error)

+ func SetLogOutput(w io.Writer)

+ func StartNATS()

+ type Bundle struct

+ Description string

+ Name string

+ Tasks []string

+ type Config struct

+ Bundles map[string]Bundle

+ EnvVars map[string]string

+ GorunUUID string

+ Groups map[string]ServerGroup

+ LogLevel string

+ MaxParallel int

+ OnEvent func(event any)

+ SSH SSH

+ SelectedTasks []string

+ Servers []Server

+ Tasks map[string]Task

+ Title string

+ func (c *Config) ExpandTaskPatterns(patterns ...string) ([]string, error)

+ func (c *Config) ExpandTaskRefs(refs ...string) ([]string, error)

+ func (c *Config) Load(r io.Reader) error

+ func (c *Config) ResolvePaths(dir string)

+ func (c *Config) Run(ctx context.Context, server ...Server) error

+ func (c *Config) RunTask(ctx context.Context, t Task, server ...Server) error

+ func (c *Config) SelectServers(f ServerFilter) ([]Server, error)

+ func (c *Config) ServerPipeline(server Server) (Server, error)

+ func (c *Config) ServersPipeline() (map[string]Server, error)

+ func (c *Config) TaskNames() []string

+ type Copy struct

+ Content string

+ Dest string

+ Dir string

+ Dst string

+ DstPath string

+ Mode string

+ Perm string

+ Src string

+ SrcFile string

+ SrcTmpl string

+ SrcTpl string

+ Template string

+ type PlanEvent struct

+ Address string

+ GorunUUID string

+ Server string

+ TaskMeta []TaskMeta

+ Tasks []string

+ Type string

+ type ProcessFinishedEvent struct

+ Duration time.Duration

+ Failed int

+ FinishedAt time.Time

+ GorunUUID string

+ Skipped int

+ Success bool

+ TotalTasks int

+ Type string

+ type ProcessStartedEvent struct

+ GorunUUID string

+ Hostname string

+ PID int

+ Servers []string

+ StartedAt time.Time

+ Title string

+ Type string

+ type RunDoneEvent struct

+ Err error

+ GorunUUID string

+ Type string

+ type SSH struct

+ Config string

+ ConfigFile string

+ Identityfile string

+ Password string

+ Port int

+ User string

+ type Server struct

+ AddTasks []string

+ EnvVars map[string]string

+ Groups []string

+ Hostname string

+ LogLevel string

+ Name string

+ SSH SSH

+ SkipTasks []string

+ Tags []string

+ TaskNames []string

+ Tasks []Task

+ func (s Server) Address() string

+ type ServerErrorEvent struct

+ Err error

+ GorunUUID string

+ Server string

+ Type string

+ type ServerFilter struct

+ Exclude []string

+ Groups []string

+ Names []string

+ Tags []string

+ func (f ServerFilter) IsZero() bool

+ type ServerGroup struct

+ EnvVars map[string]string

+ LogLevel string

+ Name string

+ SSH SSH

+ Tags []string

+ Tasks []string

+ type Task struct

+ Cmd string

+ CmdFile string

+ CmdTemplate string

+ CmdTemplateFile string

+ Copies []Copy

+ Copy []Copy

+ DependsOn []string

+ Description string

+ Details string

+ EnvVars map[string]string

+ Files []Copy

+ LogLevel string

+ Name string

+ Rerun string

+ Retries int

+ RetryDelay *time.Duration

+ RetryUnsafe bool

+ Shell string

+ Sudo bool

+ Timeout time.Duration

+ Upload []Copy

+ func (t *Task) Command() (string, error)

+ func (t *Task) CommandFor(server any) (string, error)

+ func (t Task) Attempts() int

+ func (t Task) CanRetry() bool

+ func (t Task) RetryDelayDuration() time.Duration

+ func (t Task) TimeoutDuration() time.Duration

+ type TaskEvent struct

+ Attempt int

+ Attempts int

+ Command string

+ Duration time.Duration

+ Err error

+ ExitCode int

+ GorunUUID string

+ Server string

+ State TaskState

+ Stderr string

+ Stdout string

+ Task string

+ Type string

+ type TaskExec struct

+ func NewTaskExec(server *ssh.Client, task ...Task) ([]*TaskExec, error)

+ func (t *TaskExec) Completed(ctx context.Context) error

+ func (t *TaskExec) Execute(ctx context.Context) error

+ func (t *TaskExec) Fail(ctx context.Context, err error) error

+ func (t *TaskExec) LocalExecute(ctx context.Context) error

+ func (t *TaskExec) Terminate(ctx context.Context, err error) error

+ type TaskMeta struct

+ Description string

+ Details string

+ Name string

+ Rerun string

+ type TaskState int

+ const TaskDone

+ const TaskFailed

+ const TaskPending

+ const TaskRunning

+ const TaskSkipped