config

Documentation

Overview

Package config contains helper methods for client side config management (`~/.micro/config.json` file). It uses the `JSONValues` helper

Index

• Variables
• func Get(path string) (string, error)
• func Path(paths ...string) string
• func Set(path, value string) error
• func SetConfig(configFilePath string)
• func WriteVersion(v string) error
• type Version
  • func GetVersion() (*Version, error)

Variables

var (
	// Commands defines a set of commands for local config
	Commands = []*cli.Command{
		{
			Name:   "get",
			Usage:  "Get a value by specifying [key] as an arg",
			Action: get,
		},
		{
			Name:   "set",
			Usage:  "Set a key-val using [key] [value] as args",
			Action: set,
		},
		{
			Name:   "delete",
			Usage:  "Delete a value using [key] as an arg",
			Action: del,
		},
	}
)

var (

	// File is the filepath to the config file that
	// contains all user configuration
	File = filepath.Join(user.Dir, "config.json")
)

Functions

func Get

func Get(path string) (string, error)

Get a value from the .micro file

func Path

func Path(paths ...string) string

func Set

func Set(path, value string) error

Set a value in the .micro file

func SetConfig

func SetConfig(configFilePath string)

SetConfig sets the config file

func WriteVersion

func WriteVersion(v string) error

WriteVersion will write a version update to a file ./micro/version. This indicates the current version and the last time we updated the binary. Its only used where self update is

Types

type Version

type Version struct {
	Version string    `json:"version"`
	Updated time.Time `json:"updated"`
}

Version represents ./micro/version

func GetVersion

func GetVersion() (*Version, error)

GetVersion returns the version from .micro/version. If it does not exist