backup

Documentation

Overview

Package backup creates and restores tar.gz snapshots of stool's config directory (~/.config/stool) — data.json, the encrypted vault, tool scripts, caches — so the whole setup can be saved and moved between machines.

Index

• func Export() (string, error)
• func Restore(archivePath string) error
• type Info
  • func List() []Info

Functions

func Export

func Export() (string, error)

Export writes a tar.gz of the config dir (excluding the backups subdir) and returns the archive path.

func Restore

func Restore(archivePath string) error

Restore extracts archivePath over the config dir, overwriting existing files. Existing files not present in the archive are left untouched.

Types

type Info

type Info struct {
	Path string
	Name string
	Size int64
	Time time.Time
}

Info describes one backup archive.

func List

func List() []Info

List returns existing backups, newest first.