system

local system = require("@lute/system")

WARNING

These APIs are still open to future evolution. In new major versions, they may change in backwards incompatible ways.

Summary

Entry	Description
CpuInfo	CPU information for a single logical processor, including model, speed, and time-usage breakdown.
arch	The CPU architecture of the current machine, e.g. "x64", "arm64".
cpus	Returns CPU information for each logical processor on the current machine.
freeMemory	Returns the amount of free (available) system memory in bytes.
hostName	Returns the hostname of the current machine.
os	The current operating system, e.g. "linux", "macos", "windows".
threadCount	Returns the number of logical CPU threads available on the current machine.
tmpdir	Returns the path to the system's temporary directory.
totalMemory	Returns the total amount of system memory in bytes.
uptime	Returns the system uptime in seconds.

---

Types

CpuInfo

CPU information for a single logical processor, including model, speed, and time-usage breakdown.

type CpuInfo = {
	model: string,
	speed: number,

	times: {
		sys: number,
		idle: number,
		irq: number,
		nice: number,
		user: number,
	},
}

---

Functions and Properties

system.arch

The CPU architecture of the current machine, e.g. "x64", "arm64".

string

---

system.cpus

Returns CPU information for each logical processor on the current machine.

() -> { CpuInfo }

---

system.freeMemory

Returns the amount of free (available) system memory in bytes.

() -> number

---

system.hostName

Returns the hostname of the current machine.

() -> string

---

system.os

The current operating system, e.g. "linux", "macos", "windows".

string

---

system.threadCount

Returns the number of logical CPU threads available on the current machine.

() -> number

---

system.tmpdir

Returns the path to the system's temporary directory.

() -> string

---

system.totalMemory

Returns the total amount of system memory in bytes.

() -> number

---

system.uptime

Returns the system uptime in seconds.

() -> number

---