Documentation
¶
Index ¶
- func ConfigFilePath() string
- func ContextExists(name string) (bool, error)
- func Current() (string, error)
- func GetDefaultLocalDockerSocket(dockerSocket string) string
- func GetInput(question ...string) (string, error)
- func Save(cfg *Config) error
- func SaveContext(ctx *Context, setDefault bool) error
- func SetCommandFlags(flags *pflag.FlagSet)
- type Config
- type Context
- func (c *Context) DialSSH() (*ssh.Client, error)
- func (c *Context) GetSshUri() string
- func (c *Context) ProjectDirExists() (bool, error)
- func (c *Context) ReadSmallFile(filename string) string
- func (c *Context) RunCommand(cmd *exec.Cmd) (string, error)
- func (context Context) String() (string, error)
- func (c *Context) UploadFile(source, destination string) error
- func (cc *Context) VerifyRemoteInput(existingSite bool) error
- type ContextType
- type FileReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConfigFilePath ¶
func ConfigFilePath() string
func ContextExists ¶
func GetDefaultLocalDockerSocket ¶
for local contexts, try a bunch of common paths grab the docker socket this is mostly needed for Mac OS
func SaveContext ¶
func SetCommandFlags ¶
Types ¶
type Config ¶
type Context ¶
type Context struct {
Name string `yaml:"name"`
DockerHostType ContextType `mapstructure:"type" yaml:"type"`
DockerSocket string `yaml:"docker-socket"`
ProjectName string `yaml:"project-name"`
ProjectDir string `yaml:"project-dir"`
SSHUser string `yaml:"ssh-user"`
SSHHostname string `yaml:"ssh-hostname,omitempty"`
SSHPort uint `yaml:"ssh-port,omitempty"`
SSHKeyPath string `yaml:"ssh-key,omitempty"`
EnvFile []string `yaml:"env-file"`
ComposeFile []string `yaml:"compose-file,omitempty"`
RunSudo bool `yaml:"sudo"`
// Database connection configuration
DatabaseService string `yaml:"database-service,omitempty"`
DatabaseUser string `yaml:"database-user,omitempty"`
DatabasePasswordSecret string `yaml:"database-password-secret,omitempty"`
DatabaseName string `yaml:"database-name,omitempty"`
ReadSmallFileFunc func(filename string) string `yaml:"-"`
// Extra holds plugin-specific configuration.
// Each plugin uses its own key (e.g., "drupal", "isle", "wordpress").
Extra map[string]yaml.Node `yaml:"extra,omitempty"`
}
func GetContext ¶
func (*Context) ProjectDirExists ¶
func (*Context) ReadSmallFile ¶
func (*Context) UploadFile ¶
func (*Context) VerifyRemoteInput ¶
type ContextType ¶
type ContextType string
const ( ContextLocal ContextType = "local" ContextRemote ContextType = "remote" )
type FileReader ¶
FileReader defines the behavior needed to read small files.
Click to show internal directories.
Click to hide internal directories.