tychus

Documentation

Overview

Package tychus is a command line application that will watch your files and on change, trigger a rerun of a command. It's designed to work best with web applications, but certainly not lmited to.

Unlike other application reloaders written in Go, Tychus is language agnostic. It can be used with Go, Rust, Python, Ruby, scripts, etc.

If enabled, Tychus will serve an application through a proxy. This can help mitigate annoyances like reloading your web page before the app server finishes booting. Or attempting to make a request after the server starts, but before it is ready to accept requests.

Index

• type Configuration
• type Logger
  • func NewLogger(debug bool) Logger
• type Orchestrator
  • func New(args []string, c *Configuration) *Orchestrator
  • func (o *Orchestrator) Start() error
  • func (o *Orchestrator) Stop()

Types

type Configuration

type Configuration struct {
	AppPort   int
	Ignore    []string
	Logger    Logger
	ProxyPort int
	Timeout   int
	Wait      bool
}

type Logger

type Logger interface {
	Debug(interface{})
	Debugf(string, ...interface{})
	Fatal(...interface{})
	Printf(string, ...interface{})
	Print(...interface{})
}

func NewLogger

func NewLogger(debug bool) Logger

type Orchestrator

type Orchestrator struct {
	// contains filtered or unexported fields
}

func New

func New(args []string, c *Configuration) *Orchestrator

func (*Orchestrator) Start

func (o *Orchestrator) Start() error

func (*Orchestrator) Stop

func (o *Orchestrator) Stop()

Stops Tychus and forces any processes started by it that may be running.