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 GetBackupToken() (string, error)
• func GetDefaultAdminURL() (string, error)
• func GetDefaultOrg() (string, error)
• func GetEnvToken(env string) (string, error)
• func GetRepresentingUser() (string, error)
• func GetUserCheckHash() (string, error)
• func GetUserID() (string, error)
• func GetVersion() (string, error)
• func GetVersionUpdatedAt() (string, error)
• func ResolveFilename(name string, mkdir bool) (string, error)
• func Set(filename, key, value string) error
• func SetAccessToken(token string) error
• func SetBackupToken(token string) error
• func SetDefaultAdminURL(url string) error
• func SetDefaultOrg(orgName string) error
• func SetEnvToken(env, token string) error
• func SetRepresentingUser(email string) error
• func SetUserCheckHash(hash string) error
• func SetUserID(userID 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"
	RepresentingUserCredentialsKey = "representing_user"
	BackupTokenCredentialsKey      = "backup_token"
	LatestVersionStateKey          = "latest_version"
	LatestVersionCheckedAtStateKey = "latest_version_checked_at"
	UserIDStateKey                 = "user_id"
	UserCheckHashStateKey          = "user_check_hash"
)

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 GetBackupToken

func GetBackupToken() (string, error)

GetBackupToken loads the original auth token

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 GetEnvToken

func GetEnvToken(env string) (string, error)

GetEnvToken loads the token for given env

func GetRepresentingUser

func GetRepresentingUser() (string, error)

GetRepresentingUser loads the current representing user email

func GetUserCheckHash

func GetUserCheckHash() (string, error)

GetUserCheckHash gets the hash used to determine whether to re-fetch the user ID.

func GetUserID

func GetUserID() (string, error)

GetCurrentUserID gets the current user ID

func GetVersion

func GetVersion() (string, error)

func GetVersionUpdatedAt

func GetVersionUpdatedAt() (string, error)

func ResolveFilename

func ResolveFilename(name string, mkdir bool) (string, error)

ResolveFilename resolves a file name to a full path to ~/.rill. If mkdir is true, it will create the .rill directory if it doesn't exist.

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 SetBackupToken

func SetBackupToken(token string) error

SetBackupToken saves original auth token

func SetDefaultAdminURL

func SetDefaultAdminURL(url string) error

SetDefaultAdminURL loads the default admin URL (if set)

func SetDefaultOrg

func SetDefaultOrg(orgName string) error

SetDefaultOrg saves the default org

func SetEnvToken

func SetEnvToken(env, token string) error

SetEnvToken backup the token for given env

func SetRepresentingUser

func SetRepresentingUser(email string) error

SetRepresentingUser saves representing user email

func SetUserCheckHash

func SetUserCheckHash(hash string) error

SetUserCheckHash sets the hash used to determine whether to re-fetch the user ID.

func SetUserID

func SetUserID(userID string) error

SetCurrentUserID saves the current user ID

func SetVersion

func SetVersion(version string) error

func SetVersionUpdatedAt

func SetVersionUpdatedAt(updatedAt string) error