Configuration reference#

Top-level fields#

Field

Type

Default

Description

schema_version

integer

1

Contract version, independent of the installed Limanix package version.

name

string

"example-box"

Sandbox name.

user#

Field

Type

Default

Description

name

string

"dev"

Regular guest username.

home

string

"/home/dev"

Guest user's home directory.

sudo

boolean

true

Passwordless sudo inside the guest.

resources#

Field

Type

Default

Description

arch

"arm64" or "amd64"

"arm64"

Guest architecture.

disk

string (GiB)

"10GiB"

Guest system disk size in GiB.

mem

string (GiB)

"8GiB"

Guest memory size in GiB.

cpu

integer

4

Guest CPU count, a positive integer.

home#

Field

Type

Default

Description

root

string

"~/.limanix"

Host root for <root>/<name>-<id>. Limanix creates this directory on the Mac and mounts it at user.home with read-write access.

nixos#

Field

Type

Default

Description

modules

array[string]

[]

Selected modules: lmx:NAME or lmx:NAME-VERSION from the embedded catalog, or third-party:NAME imported with limanix modules add. Omitting a version selects the module default. Multiple versions and repeated identifiers are accepted; an empty list installs no optional modules.

network#

Field

Type

Default

Description

mode

"shared"

"shared"

Shared/NAT network. The Mac reaches the guest by its own IP address.

network.ports#

Field

Type

Default

Description

tcp

array[integer]

[8080]

Inbound TCP ports in the guest firewall. Services listen on a guest network interface and are reached at <guest-ip>:<port> from the Mac.

udp

array[integer]

[]

Inbound UDP ports in the guest firewall.

env#

Guest-wide environment for login sessions and system/user services.

Type: table[string, string].

Default key

Default value

APP_ENV

"development"

APP_LOG_LEVEL

"debug"

mounts#

Host directories mounted inside the guest.

Field

Type

Default per entry

Description

mode

"rw" or "ro"

"rw"

Mount access: rw or ro.

source

string

Required

Host directory to mount inside the guest.

target

string

Required

Mount destination inside the guest.

Default entries#

mode

source

target

"rw"

"~/projects/my-project"

"/workspace"

"ro"

"~/.ssh/limanix"

"/mnt/git-keys"

Download the generated TOML example

Release metadata