alias

Documentation

Overview

Package alias provides utility functions related to alias configuration file management.

The alias configuration files are stored on `$HOME/.mole` on files named after the alias name.

Index

• func Add(alias *Alias) error
• func Delete(alias string) error
• func Show(aliasName string) (string, error)
• func ShowAll() (string, error)
• type Alias
  • func Get(aliasName string) (*Alias, error)
  • func (a Alias) String() string

Functions

func Add

func Add(alias *Alias) error

Add persists an tunnel alias to the disk

func Delete

func Delete(alias string) error

Delete destroys a alias configuration file.

func Show

func Show(aliasName string) (string, error)

Show displays the configuration parameters for the given alias name.

func ShowAll

func ShowAll() (string, error)

ShowAll displays the configuration parameters for all persisted aliases.

Types

type Alias

type Alias struct {
	Name              string   `toml:"name"`
	TunnelType        string   `toml:"type"`
	Verbose           bool     `toml:"verbose"`
	Insecure          bool     `toml:"insecure"`
	Detach            bool     `toml:"detach"`
	Source            []string `toml:"source"`
	Destination       []string `toml:"destination"`
	Server            string   `toml:"server"`
	Key               string   `toml:"key"`
	KeepAliveInterval string   `toml:"keep-alive-interval"`
	ConnectionRetries int      `toml:"connection-retries"`
	WaitAndRetry      string   `toml:"wait-and-retry"`
	SshAgent          string   `toml:"ssh-agent"`
	Timeout           string   `toml:"timeout"`
	SshConfig         string   `toml:"config"`
	Rpc               bool     `toml:"rpc"`
	RpcAddress        string   `toml:"rpc-address"`
}

Alias holds all attributes required to start a ssh port forwarding tunnel.

func Get

func Get(aliasName string) (*Alias, error)

Get returns an alias previously created

func (Alias) String

func (a Alias) String() string

String parses a Alias object to a string representation.