logic

Documentation

Index

• type Client
  • func New(c *config.Config) *Client
  • func (c *Client) CheckAndCreateLocalAppDirs() error
  • func (c *Client) CheckAndInstallMutagen() error
  • func (c *Client) ContainerChanged(container string) bool
  • func (c *Client) InstallMutagen() error
  • func (c *Client) InstallMutagenForWindows() error
  • func (c *Client) RunCmdBlackfire(cmd *cmdpkg.Command, args []string) error
  • func (c *Client) RunCmdBootstrap() error
  • func (c *Client) RunCmdDBBuildDockerComposeCommand(args []string, suppressOsStdOut ...bool) (string, error)
  • func (c *Client) RunCmdDBConnect(cmd *cobra.Command, args []string) error
  • func (c *Client) RunCmdDBDockerCompose(args []string, suppressOsStdOut ...bool) error
  • func (c *Client) RunCmdDBDockerComposeCommandModifyStdin(args []string, suppressOsStdOut ...bool) (string, error)
  • func (c *Client) RunCmdDBDockerComposeWithConfig(args []string, details compose.ConfigDetails, suppressOsStdOut ...bool) (string, error)
  • func (c *Client) RunCmdDBDump(cmd *cobra.Command, args []string) error
  • func (c *Client) RunCmdDBImport(cmd *cobra.Command, args []string) error
  • func (c *Client) RunCmdDebug(cmd *cobra.Command, args []string) error
  • func (c *Client) RunCmdEnv(args []string) error
  • func (c *Client) RunCmdEnvBuildDockerCompose(args []string, opts ...shell.Opt) (string, error)
  • func (c *Client) RunCmdEnvBuildDockerComposeTemplate(tpl *template.Template, templateList *list.List) error
  • func (c *Client) RunCmdEnvDockerCompose(args []string, opts ...shell.Opt) error
  • func (c *Client) RunCmdEnvExec(args string) error
  • func (c *Client) RunCmdEnvInit(cmd *cobra.Command, args []string) error
  • func (c *Client) RunCmdInfo(cmd *cmdpkg.Command) error
  • func (c *Client) RunCmdInstall() error
  • func (c *Client) RunCmdPluginInstall(cmd *cmdpkg.Command, args []string) error
  • func (c *Client) RunCmdPluginList() error
  • func (c *Client) RunCmdPluginListAvailable() error
  • func (c *Client) RunCmdPluginRemove(cmd *cmdpkg.Command, args []string) error
  • func (c *Client) RunCmdRoot(cmd *cmdpkg.Command) error
  • func (c *Client) RunCmdSelfUpdate(cmd *cmdpkg.Command) error
  • func (c *Client) RunCmdShell(cmd *cobra.Command, args []string) error
  • func (c *Client) RunCmdSignCertificate(args []string, force ...bool) error
  • func (c *Client) RunCmdSvc(args []string) error
  • func (c *Client) RunCmdSvcBuildDockerComposeCommand(args []string, opts ...shell.Opt) (string, error)
  • func (c *Client) RunCmdSvcDockerCompose(args []string, opts ...shell.Opt) error
  • func (c *Client) RunCmdSyncCheck() error
  • func (c *Client) RunCmdSyncFlush() error
  • func (c *Client) RunCmdSyncList(opts ...shell.Opt) (string, error)
  • func (c *Client) RunCmdSyncMonitor() error
  • func (c *Client) RunCmdSyncPause() error
  • func (c *Client) RunCmdSyncReset() error
  • func (c *Client) RunCmdSyncResume() error
  • func (c *Client) RunCmdSyncStart() error
  • func (c *Client) RunCmdSyncStop() error
  • func (c *Client) RunCmdSyncTerminate() error

Types

type Client

type Client struct {
	*config.Config
}

func New

func New(c *config.Config) *Client

func (*Client) CheckAndCreateLocalAppDirs

func (c *Client) CheckAndCreateLocalAppDirs() error

func (*Client) CheckAndInstallMutagen

func (c *Client) CheckAndInstallMutagen() error

CheckAndInstallMutagen checks if mutagen is available. If not, it's going to install mutagen.

func (*Client) ContainerChanged

func (c *Client) ContainerChanged(container string) bool

ContainerChanged returns true if the container's state is not "running" or the container's ID is changed since the last sync session.

func (*Client) InstallMutagen

func (c *Client) InstallMutagen() error

InstallMutagen installs mutagen.

func (*Client) InstallMutagenForWindows

func (c *Client) InstallMutagenForWindows() error

InstallMutagenForWindows installs mutagen for Windows.

func (*Client) RunCmdBlackfire

func (c *Client) RunCmdBlackfire(cmd *cmdpkg.Command, args []string) error

RunCmdBlackfire represents the blackfire command.

func (*Client) RunCmdBootstrap

func (c *Client) RunCmdBootstrap() error

RunCmdBootstrap represents the bootstrap command.

func (*Client) RunCmdDBBuildDockerComposeCommand

func (c *Client) RunCmdDBBuildDockerComposeCommand(args []string, suppressOsStdOut ...bool) (string, error)

DBBuildDockerComposeCommand builds up the docker-compose command's templates.

func (*Client) RunCmdDBConnect

func (c *Client) RunCmdDBConnect(cmd *cobra.Command, args []string) error

RunCmdDBConnect connects to the environment's database container.

func (*Client) RunCmdDBDockerCompose

func (c *Client) RunCmdDBDockerCompose(args []string, suppressOsStdOut ...bool) error

RunCmdDBDockerCompose function is a wrapper around the docker-compose command. It appends the current directory and current project name to the args. It also changes the output if the OS StdOut is suppressed.

func (*Client) RunCmdDBDockerComposeCommandModifyStdin

func (c *Client) RunCmdDBDockerComposeCommandModifyStdin(args []string, suppressOsStdOut ...bool) (string, error)

RunCmdDBDockerComposeCommandModifyStdin runs the passed parameters with docker-compose and returns the output.

func (*Client) RunCmdDBDockerComposeWithConfig

func (c *Client) RunCmdDBDockerComposeWithConfig(
	args []string,
	details compose.ConfigDetails,
	suppressOsStdOut ...bool,
) (string, error)

RunCmdDBDockerComposeWithConfig calls docker-compose with the previously built docker-compose configuration.

func (*Client) RunCmdDBDump

func (c *Client) RunCmdDBDump(cmd *cobra.Command, args []string) error

RunCmdDBDump dumps the database from the environment's database container.

func (*Client) RunCmdDBImport

func (c *Client) RunCmdDBImport(cmd *cobra.Command, args []string) error

RunCmdDBImport imports a database from stdin to the environment's database container.

func (*Client) RunCmdDebug

func (c *Client) RunCmdDebug(cmd *cobra.Command, args []string) error

RunCmdDebug opens a shell in the debug container.

func (*Client) RunCmdEnv

func (c *Client) RunCmdEnv(args []string) error

RunCmdEnv build up the contents for the env command.

func (*Client) RunCmdEnvBuildDockerCompose

func (c *Client) RunCmdEnvBuildDockerCompose(args []string, opts ...shell.Opt) (string, error)

RunCmdEnvBuildDockerCompose builds up the docker-compose command by passing it the previously built templates.

func (*Client) RunCmdEnvBuildDockerComposeTemplate

func (c *Client) RunCmdEnvBuildDockerComposeTemplate(tpl *template.Template, templateList *list.List) error

RunCmdEnvBuildDockerComposeTemplate builds the templates which are used to invoke docker-compose.

func (*Client) RunCmdEnvDockerCompose

func (c *Client) RunCmdEnvDockerCompose(args []string, opts ...shell.Opt) error

RunCmdEnvDockerCompose function is a wrapper around the docker-compose command. It appends the current directory and current project name to the args. It also changes the output if the OS StdOut is suppressed.

func (*Client) RunCmdEnvExec

func (c *Client) RunCmdEnvExec(args string) error

func (*Client) RunCmdEnvInit

func (c *Client) RunCmdEnvInit(cmd *cobra.Command, args []string) error

RunCmdEnvInit creates a .env file for envType based on envName.

func (*Client) RunCmdInfo

func (c *Client) RunCmdInfo(cmd *cmdpkg.Command) error

RunCmdInfo represents the info command.

func (*Client) RunCmdInstall

func (c *Client) RunCmdInstall() error

RunCmdInstall opens a shell in the environment's default application container.

func (*Client) RunCmdPluginInstall

func (c *Client) RunCmdPluginInstall(cmd *cmdpkg.Command, args []string) error

func (*Client) RunCmdPluginList

func (c *Client) RunCmdPluginList() error

func (*Client) RunCmdPluginListAvailable

func (c *Client) RunCmdPluginListAvailable() error

func (*Client) RunCmdPluginRemove

func (c *Client) RunCmdPluginRemove(cmd *cmdpkg.Command, args []string) error

func (*Client) RunCmdRoot

func (c *Client) RunCmdRoot(cmd *cmdpkg.Command) error

RunCmdRoot is the default command. If no additional args passed print the help.

func (*Client) RunCmdSelfUpdate

func (c *Client) RunCmdSelfUpdate(cmd *cmdpkg.Command) error

RunCmdSelfUpdate represents the self-update command.

func (*Client) RunCmdShell

func (c *Client) RunCmdShell(cmd *cobra.Command, args []string) error

RunCmdShell opens a shell in the environment's default application container.

func (*Client) RunCmdSignCertificate

func (c *Client) RunCmdSignCertificate(args []string, force ...bool) error

RunCmdSignCertificate represents the sign-certificate command.

func (*Client) RunCmdSvc

func (c *Client) RunCmdSvc(args []string) error

RunCmdSvc builds up the contents for the svc command.

func (*Client) RunCmdSvcBuildDockerComposeCommand

func (c *Client) RunCmdSvcBuildDockerComposeCommand(args []string, opts ...shell.Opt) (string, error)

RunCmdSvcBuildDockerComposeCommand builds up the docker-compose command by passing it the previously built templates for the common services..

func (*Client) RunCmdSvcDockerCompose

func (c *Client) RunCmdSvcDockerCompose(args []string, opts ...shell.Opt) error

RunCmdSvcDockerCompose function is a wrapper around the docker-compose command. It appends the current directory and current project name to the args. It also changes the output if the OS StdOut is suppressed.

func (*Client) RunCmdSyncCheck

func (c *Client) RunCmdSyncCheck() error

RunCmdSyncCheck checks if mutagen configuration is ok. If it doesn't exist, this function is going to generate one.

func (*Client) RunCmdSyncFlush

func (c *Client) RunCmdSyncFlush() error

RunCmdSyncFlush represents the sync flush command.

func (*Client) RunCmdSyncList

func (c *Client) RunCmdSyncList(opts ...shell.Opt) (string, error)

RunCmdSyncList represents the sync list command.

func (*Client) RunCmdSyncMonitor

func (c *Client) RunCmdSyncMonitor() error

RunCmdSyncMonitor represents the sync monitor command.

func (*Client) RunCmdSyncPause

func (c *Client) RunCmdSyncPause() error

RunCmdSyncPause represents the sync pause command.

func (*Client) RunCmdSyncReset

func (c *Client) RunCmdSyncReset() error

RunCmdSyncReset represents the sync reset command.

func (*Client) RunCmdSyncResume

func (c *Client) RunCmdSyncResume() error

RunCmdSyncResume represents the sync status command.

func (*Client) RunCmdSyncStart

func (c *Client) RunCmdSyncStart() error

RunCmdSyncStart represents the sync start command.

func (*Client) RunCmdSyncStop

func (c *Client) RunCmdSyncStop() error

RunCmdSyncStop represents the sync stop command.

func (*Client) RunCmdSyncTerminate

func (c *Client) RunCmdSyncTerminate() error

RunCmdSyncTerminate represents the sync start command.