files

Documentation

Index

• Variables
• func BuildBrevHome(fs afero.Fs, userHome string) error
• func CatFile(filePath string) (string, error)
• func DeleteFile(fs afero.Fs, filepath string) error
• func GetActiveOrgsPath(home string) string
• func GetBrevCloudflaredBinaryPath(home string) string
• func GetBrevHome(userHome string) string
• func GetBrevSSHConfigPath(home string) string
• func GetNewBackupSSHConfigFileName() string
• func GetNewBackupSSHConfigFilePath(home string) string
• func GetOnboardingStepPath(home string) string
• func GetPersonalSettingsPath(home string) string
• func GetSSHPrivateKeyFileName() string
• func GetSSHPrivateKeyPath(home string) string
• func GetUserSSHConfigPath(home string) (string, error)
• func OverwriteJSON(fs afero.Fs, filepath string, v interface{}) error
• func ReadJSON(fs afero.Fs, unsafeFilePathString string, v interface{}) error
• func ReadString(fs afero.Fs, unsafeFilePathString string) (string, error)
• func UserCachePath(brevHome string) string
• func WriteDefaultUserCache(cache *UserCache)
• func WritePersonalSettings(fs afero.Fs, home string, settings *PersonalSettings) error
• func WriteSSHPrivateKey(fs afero.Fs, data string, home string) error
• func WriteUserCache(fs afero.Fs, path string, cache *UserCache) error
• type PersonalSettings
  • func ReadPersonalSettings(fs afero.Fs, home string) (*PersonalSettings, error)
• type UserCache
  • func ReadDefaultUserCache() *UserCache
  • func ReadUserCache(fs afero.Fs, path string) *UserCache

Variables

var AppFs = afero.NewOsFs()

Functions

func BuildBrevHome

func BuildBrevHome(fs afero.Fs, userHome string) error

func CatFile

func CatFile(filePath string) (string, error)

func DeleteFile

func DeleteFile(fs afero.Fs, filepath string) error

Delete a single file altogether.

func GetActiveOrgsPath

func GetActiveOrgsPath(home string) string

func GetBrevCloudflaredBinaryPath

func GetBrevCloudflaredBinaryPath(home string) string

func GetBrevHome

func GetBrevHome(userHome string) string

func GetBrevSSHConfigPath

func GetBrevSSHConfigPath(home string) string

func GetNewBackupSSHConfigFileName

func GetNewBackupSSHConfigFileName() string

func GetNewBackupSSHConfigFilePath

func GetNewBackupSSHConfigFilePath(home string) string

func GetOnboardingStepPath

func GetOnboardingStepPath(home string) string

func GetPersonalSettingsPath

func GetPersonalSettingsPath(home string) string

func GetSSHPrivateKeyFileName

func GetSSHPrivateKeyFileName() string

func GetSSHPrivateKeyPath

func GetSSHPrivateKeyPath(home string) string

func GetUserSSHConfigPath

func GetUserSSHConfigPath(home string) (string, error)

func OverwriteJSON

func OverwriteJSON(fs afero.Fs, filepath string, v interface{}) error

OverwriteJSON data in the target file with data from the given struct

Usage (unstructured):

  OverwriteJSON("tmp/a/b/c.json", map[string]string{
	    "hi": "there",
  })

Usage (struct):

var foo myStruct
OverwriteJSON("tmp/a/b/c.json", foo)

func ReadJSON

func ReadJSON(fs afero.Fs, unsafeFilePathString string, v interface{}) error

ReadJSON reads data from a file into the given struct

Usage:

var foo myStruct
files.ReadJSON("tmp/a.json", &foo)

func ReadString

func ReadString(fs afero.Fs, unsafeFilePathString string) (string, error)

func UserCachePath

func UserCachePath(brevHome string) string

UserCachePath returns the path to the user cache file within the given brev home directory (e.g. ~/.brev).

func WriteDefaultUserCache

func WriteDefaultUserCache(cache *UserCache)

WriteDefaultUserCache writes to the default OS filesystem and home directory.

func WritePersonalSettings

func WritePersonalSettings(fs afero.Fs, home string, settings *PersonalSettings) error

func WriteSSHPrivateKey

func WriteSSHPrivateKey(fs afero.Fs, data string, home string) error

func WriteUserCache

func WriteUserCache(fs afero.Fs, path string, cache *UserCache) error

WriteUserCache writes the cache to the given filesystem.

Types

type PersonalSettings

type PersonalSettings struct {
	DefaultEditor    string `json:"default_editor"`
	AnalyticsEnabled *bool  `json:"analytics_enabled,omitempty"` // nil = never asked, true = opted in, false = opted out
	AnalyticsID      string `json:"analytics_id,omitempty"`      // stable anonymous ID for analytics
}

func ReadPersonalSettings

func ReadPersonalSettings(fs afero.Fs, home string) (*PersonalSettings, error)

type UserCache

type UserCache struct {
	Email     string `json:"email,omitempty"`
	LinuxUser string `json:"linux_user,omitempty"`
}

UserCache holds cached user preferences persisted to ~/.brev/user_cache.json.

func ReadDefaultUserCache

func ReadDefaultUserCache() *UserCache

ReadDefaultUserCache reads the user cache from the default OS filesystem and home directory. Returns an empty cache on any error.

func ReadUserCache

func ReadUserCache(fs afero.Fs, path string) *UserCache

ReadUserCache reads the cache from the given filesystem, returning an empty cache if the file doesn't exist or is malformed.