lima

Documentation

Overview

Package lima provides common methods related to Lima.

Index

• Constants
• type VMStatus
  • func GetVMStatus(creator command.LimaCmdCreator, logger flog.Logger, instanceName string) (VMStatus, error)
• type VMType
  • func GetVMType(creator command.LimaCmdCreator, logger flog.Logger, instanceName string) (VMType, error)

Constants

const (
	Running VMStatus = iota
	Stopped
	Nonexistent
	Unknown
	QEMU              VMType = "qemu"
	VZ                VMType = "vz"
	WSL               VMType = "wsl2"
	NonexistentVMType VMType = "nonexistent"
	UnknownVMType     VMType = "unknown"
)

Finch CLI assumes there are only 4 VM status below. Adding more statuses will need to make changes in the caller side.

Types

type VMStatus

type VMStatus int64

VMStatus for Lima. Relevant status defined in Lima upstream: https://github.com/lima-vm/lima/blob/fc783ec455a91d70639f9a1d7f22e9890fe6b1cd/pkg/store/instance.go#L23.

func GetVMStatus

func GetVMStatus(creator command.LimaCmdCreator, logger flog.Logger, instanceName string) (VMStatus, error)

GetVMStatus returns the Lima VM status.

type VMType

type VMType string

VMType for Lima. Relevant type defined in Lima upstream: https://github.com/lima-vm/lima/blob/f0282b2dfc4b6795295fceb2c86acd1312cef436/pkg/limayaml/limayaml.go#L53-L54.

func GetVMType

func GetVMType(creator command.LimaCmdCreator, logger flog.Logger, instanceName string) (VMType, error)

GetVMType returns the Lima VMType for a running instance.