Framework — API Reference¶

The offline-lab-framework is a bash utility library installed at /usr/lib/framework/ on the Offline Lab OS. Scripts load it with source framework || exit 1.

See Framework Integration for buildroot packaging details.

CLI¶

Command	Description
labctl	Device management CLI

Utility modules¶

Module	Description	Functions
`arguments`	CLI flag parsing	3
`array`	operations and predicates	31
`cache`	key/value store with TTL	8
`credentials`	random username and password generation	2
`depends`	tool availability checks	7
`files`	merge and deduplication	1
`fs`	path and file checks	16
`interact`	prompts and user input	5
`net`	IP, FQDN, email validation	6
`prettytable`	Unicode terminal table output	4
`proc`	command execution and output handling	10
`ssh`	key generation and agent management	10
`ssl`	certificate and key validation	23
`string`	manipulation and comparison	17
`system`	privilege escalation and sudo keepalive	2
`time`	formatting and timestamps	2
`var`	type and value checks	30

OS-specific modules¶

Module	Description	Functions
`config`	/data/config key/value store	7
`health`	system status checks	7
`rauc`	A/B OTA update operations	15
`system`	privilege escalation and sudo keepalive	2
`wifi`	wpa_supplicant management	11

Framework internals¶

Module	Description	Functions
`core`	bootstrap and module loader	0
`debug`	stack trace and error handling	5
`exit`	script termination helpers	16
`import`	module loading and circular import prevention	4
`logging`	leveled output to stderr	14
`sanity`	pre-execution checks	1