config

Documentation

Index

• Variables
• func GetDefaultContextURL() string
• func GetDefaultOrg() string
• func GetDefaultProject() string
• func GetToken() string
• func InitDebugLogFile() (*os.File, error)
• func InitPlatformerDirectory() error
• func RemoveToken()
• func SaveToken(token string)
• func SetDefaultContextURL(url string)
• func SetDefaultOrg(orgName string)
• func SetDefaultProject(projectName string)

Variables

var (
	// PlatformerDir is the filepath to the .platformer directory
	PlatformerDir string

	// ConfigPath is the filepath to the Configuration (yaml) file
	ConfigPath string

	// LogFile is the filepath to debug-logs
	LogFile string
)

Functions

func GetDefaultContextURL

func GetDefaultContextURL() string

func GetDefaultOrg

func GetDefaultOrg() string

GetDefaultOrg retrieves the saved default org name from the local config. Returns an empty string if the value is not set.

func GetDefaultProject

func GetDefaultProject() string

GetDefaultProject retrieves the saved default project name from the local config. Returns an empty string if the value is not set.

func GetToken

func GetToken() string

GetToken retrieves the locally stored perm.token Returns an empty string if the value is not set.

func InitDebugLogFile

func InitDebugLogFile() (*os.File, error)

InitDebugLogFile initializes the debug-log file (create/append) and returns a pointer to the file.

func InitPlatformerDirectory

func InitPlatformerDirectory() error

InitPlatformerDirectory prepares the .platformer directory structure required by the CLI. Creates new folders and files if they do not exist.

func RemoveToken

func RemoveToken()

RemoveToken removes the locally saved token

func SaveToken

func SaveToken(token string)

SaveToken saves the given permanent token to the local config

func SetDefaultContextURL

func SetDefaultContextURL(url string)

func SetDefaultOrg

func SetDefaultOrg(orgName string)

SetDefaultOrg saves a given organization name to the local config

func SetDefaultProject

func SetDefaultProject(projectName string)

SetDefaultProject saves a given project name to the local config