config

Documentation

Overview

Package config contains shared configuration settings for kf subcommands.

Index

• func DBPath(env *command.Env) string
• func LoadDB(env *command.Env) (*kfdb.Store, error)
• func SaveDB(env *command.Env, s *kfdb.Store) error
• func WatchDB(env *command.Env) (*kflib.DBWatcher, error)
• type Settings

Functions

func DBPath

func DBPath(env *command.Env) string

DBPath returns the database path associated with env, or "".

func LoadDB

func LoadDB(env *command.Env) (*kfdb.Store, error)

LoadDB opens the database specified by the DBPath setting. If the database does not exist, LoadDB reports an error.

func SaveDB

func SaveDB(env *command.Env, s *kfdb.Store) error

SaveDB saves the specified database to the DBPath.

func WatchDB

func WatchDB(env *command.Env) (*kflib.DBWatcher, error)

WatchDB opens a watcher for the database specified by the DBPath setting. If the database does not exist, WatchDB reports an error.

Types

type Settings

type Settings struct {
	DBPath string // path of database file (overrides KEYFISH_DB)
	PFile  string // path of passphrase file
}

Settings are shared settings used by kf subcommands.