cmd

Documentation

Index

• Variables
• func ClearConfig() (string, error)
• func Execute()
• func GetConfigDir() configdir.ConfigDir
• func SaveConfig(config *Config)
• type ApiRateLimit
• type ApiResponse
• type Config
  • func LoadConfig() (config *Config, loaded bool)

Variables

var (
	VerboseFlag bool

	PushApiEndpoint string
	PushToDevices   []string
	PushTitle       string
	PushUrl         string
	PushUrlTitle    string
	PushPriority    string
	PushSound       string
	PushTimestamp   int64
	PushAttachment  string

	LimitsApiEndpoint string
)

var (
	Version         = "dev"
	ApplicationName = "pushover-cli"
	CommandName     = "pushover-cli"
)

Functions

func ClearConfig

func ClearConfig() (string, error)

ClearConfig will remove the first configuration file that can be found from the system. It will return the path that was removed and a possible error.

func Execute

func Execute()

func GetConfigDir

func GetConfigDir() configdir.ConfigDir

func SaveConfig

func SaveConfig(config *Config)

Types

type ApiRateLimit

type ApiRateLimit struct {
	RequestsTotalPerMonth int64
	RequestsRemaining     int64
	ResetAt               time.Time
}

type ApiResponse

type ApiResponse struct {
	Status  int      `json:"status"`
	Request string   `json:"request"`
	Errors  []string `json:"errors,omitempty"`
}

type Config

type Config struct {
	UserKey  string `json:"user-key"`
	ApiToken string `json:"api-token"`
}

func LoadConfig

func LoadConfig() (config *Config, loaded bool)

LoadConfig tries to load the config that could be stored in many different locations based on the OS. It returns the current config and a flag if the config was successfully loaded.