agent

Documentation

Overview

Package agent provides facilities for extracting, installing, and connecting to agent binaries.

Index

• Constants
• func CopyBundleForTesting() error
• func DialSSH(remote *url.URL, prompter, mode string) (net.Conn, error)
• func Housekeep()
• func Install() error

Constants

const (
	// ModeInstall is the agent command to invoke for installation.
	ModeInstall = "install"
	// ModeEndpoint is the agent command to invoke for running as an endpoint.
	ModeEndpoint = "endpoint"
	// ModeVersion is the agent command to invoke to print version information.
	ModeVersion = "version"
	// ModeLegal is the agent command to invoke to print legal information.
	ModeLegal = "legal"
)

Functions

func CopyBundleForTesting

func CopyBundleForTesting() error

CopyBundleForTesting copies the agent bundle from it's build path alongside the current executable. It is useful for copying the agent bundle next to the current test executable.

func DialSSH

func DialSSH(remote *url.URL, prompter, mode string) (net.Conn, error)

func Housekeep

func Housekeep()

Housekeep performs housekeeping of agent binaries.

func Install

func Install() error

Install installs the current binary to the appropriate location for an agent binary with the current Mutagen version.