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
Variables ¶
This section is empty.
Functions ¶
func AnalyticsInfo ¶
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 ¶
Get returns a single entry from ~/.rill/{filename}. It assumes filename identifies a YAML file.
func GetAll ¶
GetAll loads all values from ~/.rill/{filename}. It assumes filename identifies a YAML file.
func GetDefaultAdminURL ¶ added in v0.24.0
GetDefaultAdminURL loads the default admin URL (if set)
func GetVersion ¶ added in v0.24.1
func GetVersionUpdatedAt ¶ added in v0.24.1
func Set ¶
Set sets a single value in ~/.rill/{filename}. It assumes filename identifies a YAML file.
func SetVersion ¶ added in v0.24.1
func SetVersionUpdatedAt ¶ added in v0.24.1
Types ¶
This section is empty.