dotrill

Documentation

Overview

Package dotrill implements setting and getting key-value pairs in YAML files in ~/.rill.

Index

• Constants
• func AnalyticsInfo() (installID string, enabled bool, err error)
• func Get(filename, key string) (string, error)
• func GetAccessToken() (string, error)
• func GetAll(filename string) (map[string]string, error)
• func GetDefaultAdminURL() (string, error)
• func GetDefaultOrg() (string, error)
• func GetVersion() (string, error)
• func GetVersionUpdatedAt() (string, error)
• func Set(filename, key, value string) error
• func SetAccessToken(token string) error
• func SetDefaultOrg(orgName string) error
• func SetVersion(version string) error
• func SetVersionUpdatedAt(updatedAt string) error

Constants

const (
	ConfigFilename      = "config.yaml"      // For user-facing config
	CredentialsFilename = "credentials.yaml" // For access tokens
	StateFilename       = "state.yaml"       // For CLI state
)

Constants for YAML files

const (
	DefaultOrgConfigKey       = "org"
	DefaultAdminURLConfigKey  = "api_url"
	AnalyticsEnabledConfigKey = "analytics_enabled"
	AccessTokenCredentialsKey = "token"
	InstallIDStateKey         = "install_id"
	VersionKey                = "latest_version"
	VersionUpdatedAtKey       = "latest_version_checked_at"
)

Constants for YAML keys

Functions

func AnalyticsInfo

func AnalyticsInfo() (installID string, enabled bool, err error)

AnalyticsInfo returns analytics info. It loads a persistent install ID from ~/.rill/state.yaml (setting one if not found). It gets analytics enabled/disabled info from ~/.rill/config.yaml (key "analytics_enabled"). It automatically migrates from the pre-v0.23 analytics config. See migrateOldAnalyticsConfig for details.

func Get

func Get(filename, key string) (string, error)

Get returns a single entry from ~/.rill/{filename}. It assumes filename identifies a YAML file.

func GetAccessToken

func GetAccessToken() (string, error)

GetToken loads the current auth token

func GetAll

func GetAll(filename string) (map[string]string, error)

GetAll loads all values from ~/.rill/{filename}. It assumes filename identifies a YAML file.

func GetDefaultAdminURL

func GetDefaultAdminURL() (string, error)

GetDefaultAdminURL loads the default admin URL (if set)

func GetDefaultOrg

func GetDefaultOrg() (string, error)

GetDefaultOrg loads the default org

func GetVersion

func GetVersion() (string, error)

func GetVersionUpdatedAt

func GetVersionUpdatedAt() (string, error)

func Set

func Set(filename, key, value string) error

Set sets a single value in ~/.rill/{filename}. It assumes filename identifies a YAML file.

func SetAccessToken

func SetAccessToken(token string) error

SetToken saves an auth token

func SetDefaultOrg

func SetDefaultOrg(orgName string) error

SetDefaultOrg saves the default org

func SetVersion

func SetVersion(version string) error

func SetVersionUpdatedAt

func SetVersionUpdatedAt(updatedAt string) error