Help us shape the future of Go! Take the 2026 Go Developer Survey

config

package
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package config defines local vault settings and resolves user-supplied vault paths.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewFile

func NewFile() (*configlib.ConfigFile[Settings], error)

NewFile configures a YAML file handle with application defaults. It does not write the file; setup explicitly creates it after valid submission.

func NormalizeVaultPath added in v0.4.0

func NormalizeVaultPath(value string) (string, error)

NormalizeVaultPath expands the home shorthand, resolves relative paths and rejects files.

Types

type Mode

type Mode string

Mode identifies the storage backend selected by configuration.

const ModeLocal Mode = "local"

ModeLocal stores documents and the derived SQLite index in the local vault.

type Settings

type Settings struct {
	Mode      Mode   `yaml:"mode,omitempty"`
	VaultPath string `yaml:"vault,omitempty"`
}

Settings contains the Overmind application settings.

func (Settings) Validate

func (settings Settings) Validate() error

Validate checks that the configuration is usable.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL