library

type Bootable struct {
	Image  *Image
	Kernel string // kernel file
	Initrd string // initramfs file
	ISO    string // the ISO, when the image is one
}

type CPIOWriter struct {
	// contains filtered or unexported fields
}

type ExitStatus int

type Image struct {
	Name     string   `json:"name"`
	Arch     string   `json:"arch"`
	Kernel   string   `json:"kernel"` // published kernel version, or "local"
	Cmdline  string   `json:"cmdline"`
	Manifest Manifest `json:"manifest"`
}

type Manifest = manifest.Manifest

type Options struct {
	// Packages are the Go packages to build, as `go build` takes them (".",
	// "./cmd/server", an import path), or pkg@version for a package outside
	// the current module. Default ".".
	Packages []string
	// Dir is the directory the packages are resolved from (default: cwd).
	Dir string
	// Arch is the target architecture, amd64 or arm64.
	Arch string
	// Format is FormatISO (the default: one hybrid ISO) or FormatDir (the
	// kernel, initramfs, command line and image.json as loose files).
	Format string
	// Output is the image to write (default <name>.iso, or <name>.vm for a
	// directory).
	Output string
	// Hostname defaults to the first program's name.
	Hostname string
	// Name overrides the program's name (only with a single package).
	Name string
	// Args, Env and Restart apply to every program.
	Args    []string
	Env     []string
	Restart string
	// Files are extra files baked in, each "src:dst" with dst absolute; a
	// directory src is copied recursively.
	Files []string
	// Debug adds coreutils, a console shell and the SSH server.
	Debug bool
	// Kernel is a local kernel image to use instead of a published one.
	Kernel string
	// KernelPackage is the published kernel to boot (default
	// DefaultKernelPackage, the slim one; "kernel" is full GoNIX's).
	KernelPackage string
	// Bootloader is a local bootloader package archive to use instead of the
	// published one (ISO images).
	Bootloader string
	// Cmdline is appended to the kernel command line.
	Cmdline string
	// Repo is the package repository (default DefaultRepo).
	Repo string
	// CacheDir caches downloaded packages (default <user cache>/gonix).
	CacheDir string
	// Log reports progress.
	Log func(format string, args ...any)
}

type Package struct {
	Name    string
	Version string
	Release string
	File    string
	Size    int64
	SHA256  string
}

type PackageFile struct {
	Name     string // path inside the archive, without a leading ./ or /
	Mode     int64
	Data     []byte // contents of a regular file
	Linkname string // target of a symlink
}

type Program = manifest.Program

type Repo struct {
	URL      string // base URL; packages live under <URL>/<arch>/
	Arch     string // amd64 or arm64
	CacheDir string // where downloaded packages are kept
	Client   *http.Client
	// Log, if set, reports downloads.
	Log func(format string, args ...any)
	// contains filtered or unexported fields
}

type RunOptions struct {
	// Memory in MiB (default 256).
	Memory int
	// CPUs (default 1).
	CPUs int
	// Publish forwards host ports to the guest, each "HOST:GUEST" (TCP),
	// listening on 127.0.0.1 unless given as "HOSTADDR:HOST:GUEST".
	Publish []string
	// Disk is a raw disk image attached as the data disk, mounted at /data.
	Disk string
	// SSHKey is a public key file authorised for root (debug images).
	SSHKey string
	// SSHPort forwards this host port, on 127.0.0.1, to the guest's SSH
	// (debug images, default 2222).
	SSHPort int
	// Cmdline is appended to the image's kernel command line.
	Cmdline string
	// DryRun prints the QEMU command instead of running it.
	DryRun bool
	// Firmware, for an ISO, boots it through firmware and its bootloader
	// instead of loading the kernel directly: "bios" (amd64) or "uefi". A
	// UEFI firmware file may follow a colon ("uefi:/path/to/code.fd").
	Firmware string
	// AsDisk attaches the ISO as a hard disk rather than a CD in a firmware
	// boot, which boots it through its hybrid MBR as from a USB stick.
	AsDisk bool
	// Config is an env file of configuration at boot, attached as a NoCloud
	// seed disk (docs/library-images.md, decisions 11–13).
	Config string
	// QEMU arguments are added to the end of the QEMU command, as given: a
	// second network card, say.
	QEMU []string

	// Log, if set, reports when the VM starts.
	Log func(format string, args ...any)
	// contains filtered or unexported fields
}