Versions in this module Expand all Collapse all v0 v0.7.1 Mar 10, 2026 Changes in this version type ClientFacade + CopyDistFolders func() error + String func() string + type DownloadOrder = supfile.DownloadOrder type InitialArgs + Force bool + SSHConfig string + TestConnections bool + var InitialArgsStore *InitialArgs = &InitialArgs{} + type RunOrder struct + Args InitialArgs + Commands []*supfile.Command + MakefileMode bool + Network *supfile.Network + Vars supfile.EnvList type Task + Dist string + Id string + type UploadOrder = supfile.UploadOrder v0.6.0 Jun 25, 2025 Changes in this version + const CsupDoSudoEnv + const CsupPasswdEnv + const HASHED_PASS + const INJECTED_COMMANDS_FILE + const MAIN_SCRIPT + const PassSeparator + const SPEW_DEPTH + const SSUP_WORK_FOLDER + const SourceDirective + const TubeNameSeparator + const VARS_FILE + const VERSION + var Colors = []string + var ErrCmd = errors.New("Unknown command/target") + var ErrConfigFile = errors.New("Unknown ssh_config file") + var ErrNetworkNoHosts = errors.New("No hosts defined for a given network") + var ErrTargetNoCommands = errors.New("No commands defined for a given target") + var ErrUnknownNetwork = errors.New(...) + var ErrUsage = errors.New(...) + var ExampleSupfile = ... + var ResetColor = "\033[0m" + func FilterNonPrintable(r io.Reader) (string, error) + func IsShell(cmd string) bool + func ResolveShell(value string) (string, error) + type AffixMappig struct + AffixedNetwork string + CommandName string + TargetName string + type ArgParserFacade interface + Parse func(conf *Supfile, initialArgs *InitialArgs, helpMenu HelpDisplayer) (*PlayBook, error) + type ClientFacade interface + Close func() error + Connect func(host NetworkHost) error + Download func(src string, dest string, silent bool) error + GenerateOnRemote func(data []byte, dest string) error + GetConnection func() *ssh.Client + GetHost func() string + GetInventory func() *Inventory + GetSSHConfig func() *ssh.ClientConfig + GetShell func() string + GetTube func() string + Prefix func() (string, int) + Run func(task *Task) error + SetConnection func(*ssh.Client) + SetTube func(name string) + Signal func(os.Signal) error + Stderr func() io.Reader + Stdin func() io.WriteCloser + Stdout func() io.Reader + Upload func(src string, dest string) error + Wait func() error + Write func(p []byte) (n int, err error) + WriteClose func() error + type Command struct + Desc string + Env EnvList + Fetch *FetchOrder + Local string + Name string + Once bool + Run string + RunOnce bool + Script string + Serial int + Stdin bool + Sudo bool + SudoPass string + Upload []*Upload + type Commands struct + Cmds map[string]Command + Names []string + func (c *Commands) Get(name string) (Command, bool) + func (c *Commands) Has(name string) bool + func (c *Commands) UnmarshalYAML(unmarshal func(interface{}) error) error + type ConnectOrder struct + ClientConfig *ssh.ClientConfig + Host string + type CopyOrder struct + Dst string + Src string + type EnvList struct + func (e *EnvList) AsExport() string + func (e *EnvList) Set(key, value string) + func (e *EnvList) UnmarshalYAML(unmarshal func(interface{}) error) error + func (e EnvList) Get(key string) string + func (e EnvList) Keys() []string + func (e EnvList) Slice() []string + type EnvVar struct + Key string + Value string + func (e EnvVar) AsExport() string + func (e EnvVar) String() string + type ErrMustUpdate struct + Msg string + func (e ErrMustUpdate) Error() string + type ErrTask struct + Reason string + Task *Task + func (e ErrTask) Error() string + type ErrUnsupportedSupfileVersion struct + Msg string + func (e ErrUnsupportedSupfileVersion) Error() string + type FetchOrder struct + Dst string + Host string + Src string + type FlagStringSlice []string + func (f *FlagStringSlice) Set(value string) error + func (f *FlagStringSlice) String() string + type HelpDisplayer struct + Color bool + ShowCmd bool + ShowMakeMode bool + ShowNetwork bool + func (h *HelpDisplayer) Show(conf *Supfile) + func (h *HelpDisplayer) ShowAll(conf *Supfile) + type HostNamespace struct + EnvStore map[string]string + func (h *HostNamespace) Get(key string) string + func (h *HostNamespace) Unset(key string) + func (h HostNamespace) Set(key, value string) + type InitState struct + Conf *Supfile + InitialArgs *InitialArgs + type InitialArgs struct + CommandArgs []string + Debug bool + DisableColor bool + DisablePrefix bool + EnvVars FlagStringSlice + ExceptHosts string + OnlyHosts string + ShowExample bool + ShowHelp bool + ShowVersion bool + SshConfig string + Supfile string + type Inventory struct + Arch string + Bash bool + Home string + IsLocal bool + OsType string + Sh bool + User string + func (i *Inventory) CheckBashCommand() []string + func (i *Inventory) CheckHomeCommand() []string + func (i *Inventory) CheckOsTypeCommand() []string + func (i *Inventory) CheckShCommand() []string + func (i *Inventory) CheckUserCommand() []string + func (i *Inventory) DetectArchCommand() []string + func (i *Inventory) GetHomeUnixCommand() []string + func (i *Inventory) GetHomeWinCommand() []string + func (i *Inventory) GetShell() string + type Network struct + Bastion string + Env EnvList + Hosts []NetworkHost + IdentityFile string + Inventory string + Name string + Password string + User string + func (n *Network) UnmarshalYAML(unmarshal func(interface{}) error) error + func (n Network) ParseInventory() ([]NetworkHost, error) + type NetworkHost struct + Env EnvList + Host string + Password string + Sudo bool + Tube string + User string + func (n *NetworkHost) UnmarshalYAML(unmarshal func(interface{}) error) error + type Networks struct + Names []string + Nets map[string]Network + func (n *Networks) Get(name string) (Network, bool) + func (n *Networks) Set(name string, value string) + func (n *Networks) UnmarshalYAML(unmarshal func(interface{}) error) error + type Play struct + Commands []*Command + Network *Network + type PlayBook struct + func (p *PlayBook) AddPlay(play Play) + func (p *PlayBook) GetPlays() []Play + func (p *PlayBook) IsMakefileMode() bool + func (p *PlayBook) MarkAsMakefileMode() + type ShellCheckFacade interface + AddNumbers func(data []byte) []byte + Check func(cmd string, cmdName string) error + type Supfile struct + Commands Commands + Desc string + Env EnvList + Networks Networks + Targets Targets + Version string + func (s Supfile) GetNetworkByName(name string) (*Network, error) + type Targets struct + Names []string + func (t *Targets) Get(name string) ([]string, bool) + func (t *Targets) GetAffixByCommandName(name string) (AffixMappig, bool) + func (t *Targets) Has(name string) bool + func (t *Targets) HasAffixes() bool + func (t *Targets) UnmarshalYAML(unmarshal func(interface{}) error) error + type Task struct + Clients []ClientFacade + Env EnvList + Input io.Reader + Run string + Sudo bool + TTY bool + type Upload struct + Dst string + Exc string + Src string
Go to main page