Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

sup

package module

Go to main page

Versions in this module

v0

v0.5.3

Apr 24, 2018

Changes in this version

type EnvList

+ func (e EnvList) Slice() []string

v0.5.2

Feb 12, 2018

v0.5.1

Jan 16, 2018

Changes in this version

+ type Commands struct

+ Names []string

+ func (c *Commands) Get(name string) (Command, bool)

+ func (c *Commands) UnmarshalYAML(unmarshal func(interface{}) error) error

type EnvList

+ func (e *EnvList) AsExport() string

+ func (e *EnvList) ResolveValues() error

+ type ErrUnsupportedSupfileVersion struct

+ Msg string

+ func (e ErrUnsupportedSupfileVersion) Error() string

type Network

+ IdentityFile string

+ User string

+ type Networks struct

+ Names []string

+ func (n *Networks) Get(name string) (Network, bool)

+ func (n *Networks) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Targets struct

+ Names []string

+ func (t *Targets) Get(name string) ([]string, bool)

+ func (t *Targets) UnmarshalYAML(unmarshal func(interface{}) error) error

v0.4.2

Aug 4, 2016

v0.4.1

Jul 19, 2016

Changes in this version

+ const VERSION

+ var Colors = []string

+ var ResetColor = "\033[0m"

+ func LocalTarCmdArgs(path, exclude string) []string

+ func NewTarStreamReader(cwd, path, exclude string) (io.Reader, error)

+ func RemoteTarCommand(dir string) string

+ func ResolveLocalPath(cwd, path, env string) (string, error)

+ type Client interface

+ Close func() error

+ Connect func(host string) error

+ Prefix func() (string, int)

+ Run func(task *Task) error

+ Signal func(os.Signal) error

+ Stderr func() io.Reader

+ Stdin func() io.WriteCloser

+ Stdout func() io.Reader

+ Wait func() error

+ Write func(p []byte) (n int, err error)

+ WriteClose func() error

+ type Command struct

+ Desc string

+ Local string

+ Name string

+ Once bool

+ Run string

+ RunOnce bool

+ Script string

+ Serial int

+ Stdin bool

+ Upload []Upload

+ type EnvList []EnvVar

+ func (e *EnvList) Set(key, value string)

+ func (e *EnvList) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type EnvVar struct

+ Key string

+ Value string

+ func (e EnvVar) AsExport() string

+ func (e EnvVar) String() string

+ type ErrConnect struct

+ Host string

+ Reason string

+ User string

+ func (e ErrConnect) Error() string

+ type ErrMustUpdate struct

+ Msg string

+ func (e ErrMustUpdate) Error() string

+ type ErrTask struct

+ Reason string

+ Task *Task

+ func (e ErrTask) Error() string

+ type LocalhostClient struct

+ func (c *LocalhostClient) Close() error

+ func (c *LocalhostClient) Connect(_ string) error

+ func (c *LocalhostClient) Prefix() (string, int)

+ func (c *LocalhostClient) Run(task *Task) error

+ func (c *LocalhostClient) Signal(sig os.Signal) error

+ func (c *LocalhostClient) Stderr() io.Reader

+ func (c *LocalhostClient) Stdin() io.WriteCloser

+ func (c *LocalhostClient) Stdout() io.Reader

+ func (c *LocalhostClient) Wait() error

+ func (c *LocalhostClient) Write(p []byte) (n int, err error)

+ func (c *LocalhostClient) WriteClose() error

+ type Network struct

+ Bastion string

+ Env EnvList

+ Hosts []string

+ Inventory string

+ func (n Network) ParseInventory() ([]string, error)

+ type SSHClient struct

+ func (c *SSHClient) Close() error

+ func (c *SSHClient) Connect(host string) error

+ func (c *SSHClient) ConnectWith(host string, dialer SSHDialFunc) error

+ func (c *SSHClient) Prefix() (string, int)

+ func (c *SSHClient) Run(task *Task) error

+ func (c *SSHClient) Signal(sig os.Signal) error

+ func (c *SSHClient) Stderr() io.Reader

+ func (c *SSHClient) Stdin() io.WriteCloser

+ func (c *SSHClient) Stdout() io.Reader

+ func (c *SSHClient) Wait() error

+ func (c *SSHClient) Write(p []byte) (n int, err error)

+ func (c *SSHClient) WriteClose() error

+ func (sc *SSHClient) DialThrough(net, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

+ type SSHDialFunc func(net, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

+ type Stackup struct

+ func New(conf *Supfile) (*Stackup, error)

+ func (sup *Stackup) Debug(value bool)

+ func (sup *Stackup) Prefix(value bool)

+ func (sup *Stackup) Run(network *Network, commands ...*Command) error

+ type Supfile struct

+ Commands map[string]Command

+ Env EnvList

+ Networks map[string]Network

+ Targets map[string][]string

+ Version string

+ func NewSupfile(file string) (*Supfile, error)

+ type Task struct

+ Clients []Client

+ Input io.Reader

+ Run string

+ TTY bool

+ type Upload struct

+ Dst string

+ Exc string

+ Src string