cmd

Documentation

Index

• Variables
• func MarshalED25519PrivateKey(key ed25519.PrivateKey, comment string) []byte
• func NewRootCmd(client *client.Client) *cobra.Command
• func TimeRegions(ctx *cmdctx.CmdContext, url string, includeNoGateway bool) ([]api.Region, <-chan TimingResponse, error)
• type BoolFlagOpts
• type Command
  • func BuildCommand(parent *Command, fn RunFn, usageText string, shortHelpText string, ...) *Command
  • func BuildCommandKS(parent *Command, fn RunFn, keystrings docstrings.KeyStrings, ...) *Command
  • func (c *Command) AddBoolFlag(options BoolFlagOpts)
  • func (c *Command) AddCommand(commands ...*Command)
  • func (c *Command) AddIntFlag(options IntFlagOpts)
  • func (c *Command) AddStringFlag(options StringFlagOpts)
  • func (c *Command) AddStringSliceFlag(options StringSliceFlagOpts)
• type Initializer
• type InitializerFn
• type Instances
• type IntFlagOpts
• type Option
• type PeerStatusJson
• type RunFn
• type SSHParams
• type StartPeerJson
• type StringFlagOpts
• type StringSliceFlagOpts
• type TimingRequest
• type TimingResponse
• type UpdatePeerJson
• type WireGuardState
  • func (s *WireGuardState) TunnelConfig() *wg.Config
• Bugs

Variables

var ErrAbort = errors.New("abort")

ErrAbort - Error generated when application aborts

Functions

func MarshalED25519PrivateKey

func MarshalED25519PrivateKey(key ed25519.PrivateKey, comment string) []byte

stolen from `mikesmitty`, thanks, you are a mikesmitty and a scholar

func NewRootCmd

func NewRootCmd(client *client.Client) *cobra.Command

func TimeRegions

func TimeRegions(ctx *cmdctx.CmdContext, url string, includeNoGateway bool) ([]api.Region, <-chan TimingResponse, error)

Types

type BoolFlagOpts

type BoolFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     bool
	EnvName     string
	Hidden      bool
}

BoolFlagOpts - options for boolean flags

type Command

type Command struct {
	*cobra.Command
}

Command - Wrapper for a cobra command

func BuildCommand

func BuildCommand(parent *Command, fn RunFn, usageText string, shortHelpText string, longHelpText string, client *client.Client, options ...Option) *Command

BuildCommand - builds a functioning Command using all the initializers

func BuildCommandKS

func BuildCommandKS(parent *Command, fn RunFn, keystrings docstrings.KeyStrings, client *client.Client, options ...Option) *Command

BuildCommandKS - A wrapper for BuildCommand which takes the docs.KeyStrings bundle instead of the coder having to manually unwrap it

func (*Command) AddBoolFlag

func (c *Command) AddBoolFlag(options BoolFlagOpts)

AddBoolFlag - Add a boolean flag for a command

func (*Command) AddCommand

func (c *Command) AddCommand(commands ...*Command)

AddCommand adds subcommands to this command

func (*Command) AddIntFlag

func (c *Command) AddIntFlag(options IntFlagOpts)

AddIntFlag - Add an integer flag to a command

func (*Command) AddStringFlag

func (c *Command) AddStringFlag(options StringFlagOpts)

AddStringFlag - Add a string flag to a command

func (*Command) AddStringSliceFlag

func (c *Command) AddStringSliceFlag(options StringSliceFlagOpts)

AddStringSliceFlag - add a string slice flag to a command

type Initializer

type Initializer struct {
	Setup  InitializerFn
	PreRun InitializerFn
}

Initializer - Retains Setup and PreRun functions

type InitializerFn

type InitializerFn func(*cmdctx.CmdContext) error

InitializerFn - A wrapper for an Initializer function that takes a command context

type Instances

type Instances struct {
	Labels    []string
	Addresses []string
}

type IntFlagOpts

type IntFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     int
	EnvName     string
	Hidden      bool
}

IntFlagOpts - options for integer flags

type Option

type Option func(*Command) Initializer

Option - A wrapper for an Initializer function that takes a command

type PeerStatusJson

type PeerStatusJson struct {
	Us     string `json:"us"`
	Them   string `json:"them"`
	Pubkey string `json:"key"`
	Error  string `json:"error"`
}

type RunFn

type RunFn func(cmdContext *cmdctx.CmdContext) error

RunFn - Run function for commands which takes a command context

type SSHParams

type SSHParams struct {
	Ctx    *cmdctx.CmdContext
	Org    *api.Organization
	App    string
	Tunnel *wg.Tunnel
	Cmd    string
}

type StartPeerJson

type StartPeerJson struct {
	Name   string `json:"name"`
	Group  string `json:"group"`
	Pubkey string `json:"pubkey"`
	Region string `json:"region"`
}

type StringFlagOpts

type StringFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     string
	EnvName     string
}

StringFlagOpts - options for string flags

type StringSliceFlagOpts

type StringSliceFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     []string
	EnvName     string
}

StringSliceFlagOpts - options a string slice flag

type TimingRequest

type TimingRequest struct {
	URL    string `json:"url"`
	Region string `json:"region"`
}

TimingRequest - Request to time a curl operation

type TimingResponse

type TimingResponse struct {
	Err               error
	HTTPCode          int     `json:"http_code"`
	SpeedDownload     int     `json:"speed_download"`
	TimeTotal         float64 `json:"time_total"`
	TimeNameLookup    float64 `json:"time_namelookup"`
	TimeConnect       float64 `json:"time_connect"`
	TimePreTransfer   float64 `json:"time_pretransfer"`
	TimeAppConnect    float64 `json:"time_appconnect"`
	TimeStartTransfer float64 `json:"time_starttransfer"`
	HTTPVersion       string  `json:"http_version"`
	RemoteIP          string  `json:"remote_ip"`
	Scheme            string  `json:"scheme"`
	Region            string  `json:"region"`
}

TimingResponse - Results from timing a curl operations

type UpdatePeerJson

type UpdatePeerJson struct {
	Pubkey string `json:"pubkey"`
}

type WireGuardState

type WireGuardState struct {
	Org          string
	Name         string
	Region       string
	LocalPublic  string
	LocalPrivate string
	DNS          string
	Peer         api.CreatedWireGuardPeer
}

func (*WireGuardState) TunnelConfig

func (s *WireGuardState) TunnelConfig() *wg.Config

BUG(tqbf): Obviously all this needs to go, and I should just make my code conform to the marshal/unmarshal protocol wireguard-go uses, but in the service of landing this feature, I'm just going to apply a layer of spackle for now.

Notes

Bugs

• do better

• can't stay this way

• Obviously all this needs to go, and I should just make my code conform to the marshal/unmarshal protocol wireguard-go uses, but in the service of landing this feature, I'm just going to apply a layer of spackle for now.

• for now, we never manage tunnels for different organizations, and while this comment is eating more space than the code I'd need to do this right, it's more fun to type, so we just hardcode.

• I think this dance just because these needed to parse for Ben's TOML code.