fleek

Documentation

Index

• Variables
• func Arch() string
• func CheckNix() bool
• func Hostname() (string, error)
• func Levels() []string
• func MkdirAll(path string) error
• func Name() (string, error)
• func Runtime() string
• func SSHAuthSock() bool
• func UserShell() (string, error)
• func Username() (string, error)
• type Alias
• type Bling
  • func DefaultBling() (*Bling, error)
  • func HighBling() (*Bling, error)
  • func LowBling() (*Bling, error)
  • func NoBling() (*Bling, error)
• type Config
  • func ReadConfig(loc string) (*Config, error)
  • func (c *Config) AddPackage(pack string) error
  • func (c *Config) AddProgram(prog string) error
  • func (c *Config) AsVersion() (*version.Version, error)
  • func (c *Config) CurrentSystem() (*System, error)
  • func (c *Config) Eject() error
  • func (c *Config) GitLocation() (string, error)
  • func (c *Config) Location() (string, error)
  • func (c *Config) MakeFlakeDir() error
  • func (c *Config) RemovePackage(pack string) error
  • func (c *Config) RemoveProgram(prog string) error
  • func (c *Config) Save() error
  • func (c *Config) UserFlakeDir() string
  • func (c *Config) UserForSystem(system string) *User
  • func (c *Config) Validate() error
  • func (c *Config) WriteInitialConfig(force bool, symlink bool) error
• type ConfigLine
• type Git
• type Package
  • func LoadPackages() ([]*Package, error)
• type Program
  • func LoadPrograms() ([]*Program, error)
• type System
  • func NewSystem() (*System, error)
  • func (s System) HomeDir() string
• type User
  • func NewUser() (*User, error)

Variables

var (
	LowPackages     = []string{"htop", "git", "github-cli", "glab"}
	DefaultPackages = []string{"fzf", "ripgrep", "vscode"}
	HighPackages    = []string{"lazygit", "jq", "yq", "neovim", "neofetch", "btop", "cheat"}
	LowPrograms     = []string{"starship"}
	DefaultPrograms = []string{"direnv"}
	HighPrograms    = []string{"exa", "bat", "atuin", "zoxide"}
)

var (
	ErrMissingFlakeDir        = errors.New("fleek.yml: missing `flakedir`")
	ErrInvalidShell           = errors.New("fleek.yml: invalid shell, valid shells are: " + strings.Join(shells, ", "))
	ErrInvalidBling           = errors.New("fleek.yml: invalid bling level, valid levels are: " + strings.Join(blingLevels, ", "))
	ErrorInvalidArch          = errors.New("fleek.yml: invalid architecture, valid architectures are: " + strings.Join(architectures, ", "))
	ErrInvalidOperatingSystem = errors.New("fleek.yml: invalid OS, valid operating systems are: " + strings.Join(operatingSystems, ", "))
	ErrPackageNotFound        = errors.New("package not found in configuration file")
	ErrProgramNotFound        = errors.New("program not found in configuration file")
)

var ErrSysNotFound = errors.New("system not found")

Functions

func Arch

func Arch() string

func CheckNix

func CheckNix() bool

CheckNix verifies that the nix command is available in user's PATH

func Hostname

func Hostname() (string, error)

func Levels

func Levels() []string

func MkdirAll

func MkdirAll(path string) error

func Name

func Name() (string, error)

func Runtime

func Runtime() string

func SSHAuthSock

func SSHAuthSock() bool

func UserShell

func UserShell() (string, error)

func Username

func Username() (string, error)

Types

type Alias

type Alias struct {
	Key         string `yaml:"key"`
	Value       string `yaml:"value"`
	Description string `yaml:"description"`
}

type Bling

type Bling struct {
	Name        string   `yaml:"name"`
	Description string   `yaml:"description"`
	Packages    []string `yaml:"packages"`
	Programs    []string `yaml:"programs"`
	PackageMap  map[string]*Package
	ProgramMap  map[string]*Program
}

func DefaultBling

func DefaultBling() (*Bling, error)

func HighBling

func HighBling() (*Bling, error)

func LowBling

func LowBling() (*Bling, error)

func NoBling

func NoBling() (*Bling, error)

type Config

type Config struct {
	MinVersion string `yaml:"min_version"`
	Debug      bool   `yaml:"-"`
	Verbose    bool   `yaml:"-"`
	Force      bool   `yaml:"-"`
	Quiet      bool   `yaml:"-"`
	FlakeDir   string `yaml:"flakedir"`
	Unfree     bool   `yaml:"unfree"`
	// bash or zsh
	Shell string `yaml:"shell"`
	// low, default, high
	Bling    string            `yaml:"bling"`
	Name     string            `yaml:"name"`
	Packages []string          `yaml:",flow"`
	Programs []string          `yaml:",flow"`
	Aliases  map[string]string `yaml:",flow"`
	Paths    []string          `yaml:"paths"`
	Ejected  bool              `yaml:"ejected"`
	Systems  []*System         `yaml:",flow"`
	Git      Git               `yaml:"git"`
	Users    []*User           `yaml:",flow"`
}

Config holds the options that will be merged into the home-manager flake.

func ReadConfig

func ReadConfig(loc string) (*Config, error)

ReadConfig returns the configuration data pointed to in the $HOME/.fleek.yml symlink

func (*Config) AddPackage

func (c *Config) AddPackage(pack string) error

func (*Config) AddProgram

func (c *Config) AddProgram(prog string) error

func (*Config) AsVersion

func (c *Config) AsVersion() (*version.Version, error)

func (*Config) CurrentSystem

func (c *Config) CurrentSystem() (*System, error)

func (*Config) Eject

func (c *Config) Eject() error

WriteEjectConfig updates the .fleek.yml file to indicated ejected status

func (*Config) GitLocation

func (c *Config) GitLocation() (string, error)

GitLocation returns the path for the fleek configuration git directory

func (*Config) Location

func (c *Config) Location() (string, error)

ConfigLocation returns the path for the fleek configuration file.

func (*Config) MakeFlakeDir

func (c *Config) MakeFlakeDir() error

MakeFlakeDir creates the directory that holds the interpolated flake.

func (*Config) RemovePackage

func (c *Config) RemovePackage(pack string) error

func (*Config) RemoveProgram

func (c *Config) RemoveProgram(prog string) error

func (*Config) Save

func (c *Config) Save() error

func (*Config) UserFlakeDir

func (c *Config) UserFlakeDir() string

func (*Config) UserForSystem

func (c *Config) UserForSystem(system string) *User

func (*Config) Validate

func (c *Config) Validate() error

func (*Config) WriteInitialConfig

func (c *Config) WriteInitialConfig(force bool, symlink bool) error

type ConfigLine

type ConfigLine struct {
	Key   string `yaml:"key"`
	Value string `yaml:"value"`
}

ConfigLine represents a line of a program's configuration. It must be in the form of `key = value“ such that multiple config lines for the same program can be appended together to create a valid configuration.

type Git

type Git struct {
	Enabled    bool `yaml:"enabled"`
	AutoCommit bool `yaml:"autocommit"`
	AutoPush   bool `yaml:"autopush"`
	AutoPull   bool `yaml:"autopull"`
}

type Package

type Package struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
}

Package is an binary or library that can be installed

func LoadPackages

func LoadPackages() ([]*Package, error)

type Program

type Program struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`

	ConfigLines []ConfigLine `yaml:"config_lines,flow"`
	Aliases     []Alias      `yaml:",flow"`
}

Program is an application that is installed and also has configuration attached.

func LoadPrograms

func LoadPrograms() ([]*Program, error)

type System

type System struct {
	Hostname string `yaml:"hostname"`
	Username string `yaml:"username"`
	Arch     string `yaml:"arch"`
	OS       string `yaml:"os"`
}

func NewSystem

func NewSystem() (*System, error)

func (System) HomeDir

func (s System) HomeDir() string

type User

type User struct {
	Username          string `yaml:"username"`
	Name              string `yaml:"name"`
	Email             string `yaml:"email"`
	SSHPublicKeyFile  string `yaml:"ssh_public_key_file"`
	SSHPrivateKeyFile string `yaml:"ssh_private_key_file"`
}

func NewUser

func NewUser() (*User, error)