modules

Documentation

Index

• Constants
• func ColorString(c Color, s string) string
• func InstallRoot() string
• func PollNgrokAPI(apiURL string, timeout time.Duration) (string, error)
• func PrintError(msg string)
• func PrintHeader(title string)
• func PrintInfo(msg string)
• func PrintLink(url string)
• func PrintSeparator()
• func PrintSuccess(msg string)
• func PrintWarning(msg string)
• func ProviderRegistry() map[string]Provider
• type CloudflaredProvider
  • func (CloudflaredProvider) Args(port int) []string
  • func (CloudflaredProvider) Confidence() string
  • func (CloudflaredProvider) FormatURL(m string) string
  • func (CloudflaredProvider) Hint() string
  • func (CloudflaredProvider) LocalAPIURL() string
  • func (CloudflaredProvider) Name() string
  • func (CloudflaredProvider) Prepare(plat Platform) (string, error)
  • func (CloudflaredProvider) URLPattern() *regexp.Regexp
  • func (CloudflaredProvider) UsesLocalAPI() bool
• type Color
• type LocalTunnelProvider
  • func (LocalTunnelProvider) Args(port int) []string
  • func (LocalTunnelProvider) Confidence() string
  • func (LocalTunnelProvider) FormatURL(m string) string
  • func (LocalTunnelProvider) Hint() string
  • func (LocalTunnelProvider) LocalAPIURL() string
  • func (LocalTunnelProvider) Name() string
  • func (LocalTunnelProvider) Prepare(plat Platform) (string, error)
  • func (LocalTunnelProvider) URLPattern() *regexp.Regexp
  • func (LocalTunnelProvider) UsesLocalAPI() bool
• type NgrokProvider
  • func (NgrokProvider) Args(port int) []string
  • func (NgrokProvider) Confidence() string
  • func (NgrokProvider) FormatURL(m string) string
  • func (NgrokProvider) Hint() string
  • func (NgrokProvider) LocalAPIURL() string
  • func (NgrokProvider) Name() string
  • func (NgrokProvider) Prepare(plat Platform) (string, error)
  • func (NgrokProvider) URLPattern() *regexp.Regexp
  • func (NgrokProvider) UsesLocalAPI() bool
• type PinggyProvider
  • func (PinggyProvider) Args(port int) []string
  • func (PinggyProvider) Confidence() string
  • func (PinggyProvider) FormatURL(m string) string
  • func (PinggyProvider) Hint() string
  • func (PinggyProvider) LocalAPIURL() string
  • func (PinggyProvider) Name() string
  • func (PinggyProvider) Prepare(plat Platform) (string, error)
  • func (PinggyProvider) URLPattern() *regexp.Regexp
  • func (PinggyProvider) UsesLocalAPI() bool
• type Platform
  • func DetectPlatform() Platform
• type Provider

Constants

const (
	CharSuccess = "[+]"
	CharError   = "[-]"
	CharWarning = "[!]"
	CharInfo    = "[*]"
	CharLink    = "[>]"
	CharRocket  = "[~]"
)

Functions

func ColorString

func ColorString(c Color, s string) string

func InstallRoot

func InstallRoot() string

func PollNgrokAPI

func PollNgrokAPI(apiURL string, timeout time.Duration) (string, error)

func PrintError

func PrintError(msg string)

func PrintHeader

func PrintHeader(title string)

func PrintInfo

func PrintInfo(msg string)

func PrintLink

func PrintLink(url string)

func PrintSeparator

func PrintSeparator()

func PrintSuccess

func PrintSuccess(msg string)

func PrintWarning

func PrintWarning(msg string)

func ProviderRegistry

func ProviderRegistry() map[string]Provider

Types

type CloudflaredProvider

type CloudflaredProvider struct{}

func (CloudflaredProvider) Args

func (CloudflaredProvider) Args(port int) []string

func (CloudflaredProvider) Confidence

func (CloudflaredProvider) Confidence() string

func (CloudflaredProvider) FormatURL

func (CloudflaredProvider) FormatURL(m string) string

func (CloudflaredProvider) Hint

func (CloudflaredProvider) Hint() string

func (CloudflaredProvider) LocalAPIURL

func (CloudflaredProvider) LocalAPIURL() string

func (CloudflaredProvider) Name

func (CloudflaredProvider) Name() string

func (CloudflaredProvider) Prepare

func (CloudflaredProvider) Prepare(plat Platform) (string, error)

func (CloudflaredProvider) URLPattern

func (CloudflaredProvider) URLPattern() *regexp.Regexp

func (CloudflaredProvider) UsesLocalAPI

func (CloudflaredProvider) UsesLocalAPI() bool

type Color

type Color string

const (
	Reset   Color = "\033[0m"
	Red     Color = "\033[31m"
	Green   Color = "\033[32m"
	Yellow  Color = "\033[33m"
	Blue    Color = "\033[34m"
	Magenta Color = "\033[35m"
	Cyan    Color = "\033[36m"
	White   Color = "\033[37m"
	Bold    Color = "\033[1m"
)

type LocalTunnelProvider

type LocalTunnelProvider struct{}

func (LocalTunnelProvider) Args

func (LocalTunnelProvider) Args(port int) []string

func (LocalTunnelProvider) Confidence

func (LocalTunnelProvider) Confidence() string

func (LocalTunnelProvider) FormatURL

func (LocalTunnelProvider) FormatURL(m string) string

func (LocalTunnelProvider) Hint

func (LocalTunnelProvider) Hint() string

func (LocalTunnelProvider) LocalAPIURL

func (LocalTunnelProvider) LocalAPIURL() string

func (LocalTunnelProvider) Name

func (LocalTunnelProvider) Name() string

func (LocalTunnelProvider) Prepare

func (LocalTunnelProvider) Prepare(plat Platform) (string, error)

func (LocalTunnelProvider) URLPattern

func (LocalTunnelProvider) URLPattern() *regexp.Regexp

func (LocalTunnelProvider) UsesLocalAPI

func (LocalTunnelProvider) UsesLocalAPI() bool

type NgrokProvider

type NgrokProvider struct{}

func (NgrokProvider) Args

func (NgrokProvider) Args(port int) []string

func (NgrokProvider) Confidence

func (NgrokProvider) Confidence() string

func (NgrokProvider) FormatURL

func (NgrokProvider) FormatURL(m string) string

func (NgrokProvider) Hint

func (NgrokProvider) Hint() string

func (NgrokProvider) LocalAPIURL

func (NgrokProvider) LocalAPIURL() string

func (NgrokProvider) Name

func (NgrokProvider) Name() string

func (NgrokProvider) Prepare

func (NgrokProvider) Prepare(plat Platform) (string, error)

func (NgrokProvider) URLPattern

func (NgrokProvider) URLPattern() *regexp.Regexp

func (NgrokProvider) UsesLocalAPI

func (NgrokProvider) UsesLocalAPI() bool

type PinggyProvider

type PinggyProvider struct{}

func (PinggyProvider) Args

func (PinggyProvider) Args(port int) []string

func (PinggyProvider) Confidence

func (PinggyProvider) Confidence() string

func (PinggyProvider) FormatURL

func (PinggyProvider) FormatURL(m string) string

func (PinggyProvider) Hint

func (PinggyProvider) Hint() string

func (PinggyProvider) LocalAPIURL

func (PinggyProvider) LocalAPIURL() string

func (PinggyProvider) Name

func (PinggyProvider) Name() string

func (PinggyProvider) Prepare

func (PinggyProvider) Prepare(plat Platform) (string, error)

func (PinggyProvider) URLPattern

func (PinggyProvider) URLPattern() *regexp.Regexp

func (PinggyProvider) UsesLocalAPI

func (PinggyProvider) UsesLocalAPI() bool

type Platform

type Platform struct {
	OS        string
	Arch      string
	IsWindows bool
	IsTermux  bool
	RealOS    string
}

func DetectPlatform

func DetectPlatform() Platform

type Provider

type Provider interface {
	Name() string
	Hint() string
	Confidence() string
	Prepare(plat Platform) (string, error)
	Args(port int) []string
	UsesLocalAPI() bool
	LocalAPIURL() string
	URLPattern() *regexp.Regexp
	FormatURL(match string) string
}