store

Documentation

Index

• Constants
• func InstanceDir(name string) (string, error)
• func Instances() ([]string, error)
• func LimaConfigDir() (string, error)
• func LimaDir() (string, error)
• func LoadYAMLByFilePath(filePath string) (*limayaml.LimaYAML, error)
• type Instance
  • func Inspect(instName string) (*Instance, error)
  • func (inst *Instance) LoadYAML() (*limayaml.LimaYAML, error)
• type Status

Constants

const DotLima = ".lima"

DotLima is a directory that appears under the home directory.

Functions

func InstanceDir

func InstanceDir(name string) (string, error)

InstanceDir returns the instance dir. InstanceDir does not check whether the instance exists

func Instances

func Instances() ([]string, error)

Instances returns the names of the instances under LimaDir.

func LimaConfigDir

func LimaConfigDir() (string, error)

LimaConfigDir returns the path of the config directory, $LIMA_HOME/_config.

func LimaDir

func LimaDir() (string, error)

LimaDir returns the abstract path of `~/.lima` (or $LIMA_HOME, if set).

NOTE: We do not use `~/Library/Application Support/Lima` on macOS. We use `~/.lima` so that we can have enough space for the length of the socket path, which can be only 104 characters on macOS.

func LoadYAMLByFilePath

func LoadYAMLByFilePath(filePath string) (*limayaml.LimaYAML, error)

LoadYAMLByFilePath loads and validates the yaml.

Types

type Instance

type Instance struct {
	Name         string        `json:"name"`
	Status       Status        `json:"status"`
	Dir          string        `json:"dir"`
	Arch         limayaml.Arch `json:"arch"`
	SSHLocalPort int           `json:"sshLocalPort,omitempty"`
	HostAgentPID int           `json:"hostAgentPID,omitempty"`
	QemuPID      int           `json:"qemuPID,omitempty"`
	Errors       []error       `json:"errors,omitempty"`
}

func Inspect

func Inspect(instName string) (*Instance, error)

Inspect returns err only when the instance does not exist (os.ErrNotExist). Other errors are returned as *Instance.Errors

func (*Instance) LoadYAML

func (inst *Instance) LoadYAML() (*limayaml.LimaYAML, error)

type Status

type Status = string

const (
	StatusUnknown Status = ""
	StatusBroken  Status = "Broken"
	StatusStopped Status = "Stopped"
	StatusRunning Status = "Running"
)